> ## Documentation Index
> Fetch the complete documentation index at: https://docs.taidalos.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Media Search Aggregate



## OpenAPI

````yaml GET /v1/media-searches/aggregate/{media_search_id}
openapi: 3.0.0
info:
  title: Taidalos API Documentation
  termsOfService: https://www.taidalos.com/gtc/
  contact:
    name: Customer Support
    url: https://www.taidalos.com
    email: cs@taidalos.com
  version: '1.0'
servers:
  - url: https://api.taidalos.com
security: []
tags:
  - description: Operations about subjects
    name: Subjects
  - description: Operations about media search configuration
    name: Media Search Configuration
  - description: Operations about media search
    name: Media Search
externalDocs:
  description: Get started with guides
  url: https://taidalos.com/tags/guide/
paths:
  /v1/media-searches/aggregate/{media_search_id}:
    get:
      tags:
        - Media Search
      summary: Media Search Aggregate
      parameters:
        - description: media_search_id
          name: media_search_id
          in: path
          required: true
          schema:
            type: string
        - description: 'Remove Markdown (options: true, false, default: false)'
          name: remove_markdown
          in: query
          schema:
            type: string
        - description: <Authorization Token>
          name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/main.getMediaSearchAggregateResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/main.problemJson'
components:
  schemas:
    main.getMediaSearchAggregateResponse:
      type: object
      properties:
        data:
          description: >-
            `data` holds the aggregated response data, including media search
            details, subject information, configuration, and organisation
            metadata.
          allOf:
            - $ref: '#/components/schemas/main.getMediaSearchAggregateResponseItem'
    main.problemJson:
      type: object
      properties:
        context:
          description: >-
            `context` provides additional information about the error, including
            the HTTP method and path where it occurred.
          allOf:
            - $ref: '#/components/schemas/main.defaultProblemContext'
        details:
          description: >-
            `details` provides a detailed human-readable explanation of the
            specific error.
          type: string
          example: Details explaining the error
        instance:
          description: >-
            `instance` specifies a unique URI identifying the context of the
            error, such as organisation, user, and request details.
          type: string
          example: /org/{org_id}/user/{user_id}/request-id/{request_id}
        title:
          description: >-
            `title` provides a short, human-readable summary of the problem type
            or error encountered.
          type: string
          example: Error ShortName
        type:
          description: >-
            `type` is a URI reference that identifies the problem type, allowing
            clients to recognize the type of error encountered.
          type: string
          example: https://errors.taidalos.com/common/{error-type}
    main.getMediaSearchAggregateResponseItem:
      type: object
      properties:
        media_search:
          description: >-
            `media_search` represents the aggregated data related to a media
            search, including executions and summaries.
          allOf:
            - $ref: '#/components/schemas/main.mediaSearchAggregate'
        media_search_configuration:
          description: >-
            `media_search_configuration` holds the configuration details for
            executing a media search, including filters and limits.
          allOf:
            - $ref: '#/components/schemas/main.mediaSearchConfiguration'
        organisation:
          description: >-
            `organisation` holds metadata about the associated organisation,
            including identifiers and related details.
          allOf:
            - $ref: '#/components/schemas/main.organisationMeta'
        subject:
          description: >-
            `subject` holds the subject entity data, including identifiers,
            name, type, industries, nationalities, and more.
          allOf:
            - $ref: '#/components/schemas/main.subjectEntity'
    main.defaultProblemContext:
      type: object
      required:
        - method
        - path
      properties:
        method:
          description: >-
            `method` specifies the HTTP method (e.g., GET, POST) that was used
            in the problematic request.
          type: string
          example: '{method}'
        path:
          description: >-
            `path` specifies the HTTP request path associated with the
            encountered problem.
          type: string
          example: '{path}'
        timestamp:
          type: string
    main.mediaSearchAggregate:
      type: object
      properties:
        created_at:
          description: >-
            `created_at` represents the timestamp when the media search
            aggregate was created.
          type: string
          example: '2024-10-22T07:37:56.676Z'
        created_by:
          description: >-
            `created_by` represents the user who initiated or created the
            record.
          allOf:
            - $ref: '#/components/schemas/main.createdBy'
        media_search_executions:
          description: >-
            `media_search_executions` contains an array of media search
            execution records related to a specific media search.
          type: array
          items:
            $ref: '#/components/schemas/main.mediaSearchExecution'
        media_search_id:
          description: '`media_search_id` is a unique identifier for a media search.'
          type: string
          example: 4ccd19dc-c60b-4ce7-b512-bba106f1cb16
        media_search_summaries:
          description: >-
            media_search_summaries contains a list of media search summary
            objects associated with a media search.
          type: array
          items:
            $ref: '#/components/schemas/main.mediaSearchSummary'
    main.mediaSearchConfiguration:
      type: object
      properties:
        created_at:
          description: >-
            `created_at` is the timestamp when the media search configuration
            was created.
          type: string
          example: '2024-10-22T07:37:56.676Z'
        created_by:
          description: >-
            `created_by` represents the user who created the media search
            configuration.
          allOf:
            - $ref: '#/components/schemas/main.createdBy'
        disambiguation_auto_risk_assessment:
          description: >-
            `disambiguation_auto_risk_assessment` if `active` is set `true`,
            articles with the set disambiguation `threshold` or below will be
            automatically risk-assessed as not risky.
          type: object
          properties:
            active:
              description: >-
                `active` indicates whether the
                `disambiguation_auto_risk_assessment`is active or not
              type: boolean
              example: true
            threshold:
              description: >-
                `threshold` if an article has disambiguation match the score of
                threshold or below, the article will be risk-assessed as not
                risky.
              type: integer
              example: 2
        is_template:
          description: '`is_template` indicates if this configuration is a template'
          type: boolean
          example: false
        keyword_lists:
          description: >-
            `keyword_lists` represents a list of keyword lists associated with
            the configuration.
          type: array
          items:
            $ref: '#/components/schemas/main.KeyWordListResponseItem'
        keywords:
          description: >-
            `WARNING: the field keywords is deprecated - use keyword_lists
            instead.` `keywords` contains all all keywords from
            `keyword_lists`.`
          type: array
          items:
            type: string
          example:
            - Fraud
            - Theft
            - Steal
            - Scam
            - Money Laundering
            - Sanction
            - Human Rights Violation
            - Terrorist
            - Organised Crime
            - Corrupt
            - Bribe
            - Tax Evasion
            - Convicted
            - Sentenced
            - Arrested
            - Child Labour
        language:
          description: >-
            `language` specifies the language used for the media search
            configuration.
          type: string
          example: en
        look_back_period:
          description: >-
            `look_back_period` specifies the look-back period for the media
            search configuration. All articles that got published before the
            look back period (today - days specified) are ignored.
          allOf:
            - $ref: '#/components/schemas/main.lookBackPeriod'
        max_number_of_results:
          description: >-
            `max_number_of_results` defines the maximum number of results
            allowed for a media search configuration.
          type: integer
          example: 20
        media_search_configuration_id:
          description: >-
            `media_search_configuration_id` holds the unique identifier for the
            media search configuration.
          type: string
          example: d43a4ec2-3eb8-46ad-9ca9-09a26540968f
        organisation_id:
          description: >-
            `organisation_id` is the unique identifier of the organisation
            associated with the configuration
          type: string
          example: 07f8269e-4583-41c5-bb0e-bea37f3c0569
        reference:
          description: >-
            `reference` holds the reference which can be used for referencing
            the media search configuration.
          type: string
          example: english_generic
        risk_categories:
          description: >-
            `risk_categories` lists the risk categories associated with the
            media search.
          type: array
          items:
            type: string
          example:
            - Fraud
            - Money Laundering
            - Sanctions
            - Human Rights Abuse
            - Environmental Abuse
            - Terrorism
            - Organized Crime
            - Corruption
            - Tax Crimes
            - Violence
            - Theft
            - Discrimination
            - Other
        subject_names_fuzzy:
          description: >-
            `subject_names_fuzzy` is the fuzzy matching standard for subject
            names
          type: string
          example: STANDARD
        title:
          description: '`title` represents the title of the media search configuration.'
          type: string
          example: English Generic
        version:
          description: >-
            `version` represents the version number of the media search
            configuration.
          type: integer
          example: 1
    main.organisationMeta:
      type: object
      properties:
        organisation_id:
          description: >-
            `organisation_id` represents the unique identifier of the
            organisation.
          type: string
          example: d43a4ec2-3eb8-46ad-9ca9-09a26540968f
    main.subjectEntity:
      type: object
      properties:
        aliases:
          description: '`aliases` represent alternative names associated with the subject.'
          type: array
          items:
            type: string
          example:
            - Facebook
            - Instagram
        created_at:
          description: >-
            `created_at` represents the time when the subject entity was
            created.
          type: string
          example: '2024-10-22T07:37:56.676Z'
        created_by:
          description: >-
            `created_by` represents information about the user that created the
            subject.
          allOf:
            - $ref: '#/components/schemas/main.createdBy'
        date_of_birth:
          description: '`date_of_birth` represents the date of birth of a subject.'
          type: string
          example: '1980-04-07T00:00:00.000Z'
        date_of_incorporation:
          description: >-
            `date_of_incorporation` represents the date when the entity was
            legally formed, formatted as a string.
          type: string
          example: '1980-04-07T00:00:00.000Z'
        industries:
          description: >-
            `industries` represents a list of industries associated with the
            subject.
          type: array
          items:
            type: string
          example:
            - Banking
            - Insurance
            - Telecommunications
        internal_id:
          description: >-
            `internal_id` represents the internal identifier for a subject,
            typically used for referencing within internal systems.
          type: string
          example: crm_id#123456789
        name:
          description: '`name` represents the name of the subject.'
          type: string
          example: Jan Marsalek
        nationalities:
          description: >-
            `nationalities` represents the list of nationalities associated with
            the subject.
          type: array
          items:
            type: string
          example:
            - US
            - GB
        places:
          description: '`places` contains a list of places associated with the subject.'
          type: array
          items:
            $ref: '#/components/schemas/main.subjectPlace'
        subject_id:
          description: '`subject_id` represents the unique identifier for the subject.'
          type: string
          example: d43a4ec2-3eb8-46ad-9ca9-09a26540968f
        type:
          description: >-
            `type` represents the category of the subject, which could be an
            individual (INDIVIDUAL) or an organisation (LEGAL_ENTITY).
          type: string
          enum:
            - INDIVIDUAL
            - LEGAL_ENTITY
            - VESSEL
    main.createdBy:
      type: object
      properties:
        user_id:
          description: '`user_id` represents the unique identifier for the user.'
          type: string
          example: d43a4ec2-3eb8-46ad-9ca9-09a26540968f
    main.mediaSearchExecution:
      type: object
      properties:
        created_at:
          description: >-
            `created_at` signifies the timestamp when the media search execution
            record was created.
          type: string
          example: '2024-10-22T07:37:04.340Z'
        media_search_articles:
          description: >-
            `media_search_articles` contains an array of media articles
            retrieved for a media search execution.
          type: array
          items:
            $ref: '#/components/schemas/main.mediaArticle'
        media_search_configuration_version:
          description: >-
            `media_search_configuration_version` denotes the version number of
            the media search configuration applied during the search execution.
          type: integer
          example: 1
        media_search_execution_id:
          description: >-
            `media_search_execution_id` represents the unique identifier for a
            media search execution.
          type: string
          example: 4ccd19dc-c60b-4ce7-b512-bba106f1cb16
        status:
          description: '`status` represents the status of the media search execution.'
          type: string
          enum:
            - INITIATED
            - PENDING
            - PROCESSING
            - DONE
            - ERROR
    main.mediaSearchSummary:
      type: object
      properties:
        created_at:
          description: >-
            `created_at` represents the timestamp when the media search summary
            was created.
          type: string
          example: '2024-10-22T07:37:56.676Z'
        created_by:
          description: >-
            `created_by´ represents the user who created the media search
            summary
          allOf:
            - $ref: '#/components/schemas/main.createdBy'
        media_search_summary_id:
          description: >-
            `media_search_summary_id` is a unique identifier for a media search
            summary.
          type: string
          example: 6f677744-e428-4706-b51e-d9b03afc5b42
        risk_categories:
          description: >-
            `risk_categories` specifies the categories of risk associated with
            the media search summary.
          type: array
          items:
            type: string
          example:
            - Fraud
            - Money Laundering
            - Sanctions
            - Human Rights Abuse
            - Environmental Abuse
            - Terrorism
            - Organized Crime
            - Corruption
            - Tax Crimes
            - Violence
            - Theft
            - Discrimination
        risky:
          description: >-
            `risky` indicates whether the media search summary content is
            considered risky.
          type: boolean
          example: true
        summary:
          description: summary provides a summary of all articles
          type: string
          example: >-
            Jan Marsalek, former COO of Wirecard, is implicated in major fraud
            scandals, embezzlement, espionage, and illegal financial activities.
            He is a fugitive with ties to Russian intelligence and military
            services, involved in espionage activities and financial fraud.
            Marsalek is wanted by multiple authorities and is considered a
            high-risk individual in terms of financial crimes and security
            threats.
    main.KeyWordListResponseItem:
      type: object
      properties:
        keyword_list_id:
          type: string
        keywords:
          type: array
          items:
            type: string
        name:
          type: string
    main.lookBackPeriod:
      type: object
      properties:
        days:
          description: >-
            `days` specifies the look back period in days, represented as an
            integer.

            All articles that got published before the look back period (today -
            days specified) will be ignored.
          type: integer
          example: 360
        is_active:
          description: >-
            `is_active` indicates whether a look back period is enabled for the
            given configuration.
          type: boolean
          example: true
    main.subjectPlace:
      type: object
      properties:
        description:
          description: '`description` provides a brief explanation or label for the place.'
          type: string
          example: Head Office
        place:
          description: >-
            `place` represents the specific location associated with the
            subject, formatted as an address or location string.
          type: string
          example: 123 Main Street, New York, USA
    main.mediaArticle:
      type: object
      properties:
        created_at:
          description: >-
            `created_at` indicates the timestamp when the media article was
            created.
          type: string
          example: '2024-10-22T07:37:56.676Z'
        dispositions:
          description: >-
            `dispositions` holds an array of disposition records related to the
            media article.
          type: array
          items:
            $ref: '#/components/schemas/main.disposition'
        headline:
          description: >-
            `headline` represents the title or main heading of the media
            article.
          type: string
          example: Spy scandal revives fears of Austrian exposure to Russia
        media_search_article_id:
          description: >-
            `media_search_article_id` represents the unique identifier for a
            specific media search article.
          type: string
          example: 4ccd19dc-c60b-4ce7-b512-bba106f1cb16
        media_search_execution_id:
          description: >-
            `media_search_execution_id` (uuid) represents the unique identifier
            for a media search execution.
          type: string
          example: 0a1a489b-50df-41a1-920d-6c6df381031e
        media_search_id:
          description: >-
            `media_search_id` represents the unique identifier for a media
            search.
          type: string
          example: 4ccd19dc-c60b-4ce7-b512-bba106f1cb16
        organisation_id:
          description: >-
            `organisation_id` represents the unique identifier for an
            organisation.
          type: string
          example: d43a4ec2-3eb8-46ad-9ca9-09a26540968f
        publication_date:
          description: >-
            `publication_date` indicates the date when the media article was
            published.
          type: string
          example: '2024-10-22T07:37:56.676Z'
        rank:
          description: '`rank` represents the position or order of the media article.'
          type: integer
          example: 1
        subject_match:
          description: >-
            `subject_match` represents additional contextual information or
            resolution for ambiguous data fields in an article.
          allOf:
            - $ref: '#/components/schemas/main.subjectMatch'
        url:
          description: '`url'' represents the web address of the media article.'
          type: string
          example: >-
            https://www.wired.com/story/spy-scandal-revives-fears-austrian-exposure-russia/
    main.disposition:
      type: object
      required:
        - risk
      properties:
        created_at:
          description: '`created_at` represents the timestamp when the record was created.'
          type: string
          example: '2024-10-22T07:37:56.676Z'
        created_by:
          description: >-
            `created_by` represents the user who created the media search
            article disposition.
          allOf:
            - $ref: '#/components/schemas/main.createdBy'
        justification:
          description: >-
            `justification` provides the reasoning or explanation behind a
            particular disposition in a media search article.
          type: string
          example: >-
            Jan Marsalek, an Austrian executive and fugitive, is central to
            Austria's biggest espionage scandal. He is wanted by German police
            for alleged fraud and is believed to be in Russia. Marsalek is
            accused of commissioning former security officials to pass sensitive
            information to Russia. He fled to Moscow in 2020 and was reportedly
            recruited by Russian agents in 2014.
        media_search_article_disposition_id:
          description: >-
            `media_search_article_disposition_id` represents the unique
            identifier for the disposition assigned to a media search article.
          type: string
          example: f0127405-c357-469a-a145-df77c5f0810f
        media_search_article_id:
          description: >-
            `media_search_article_id` represents the unique identifier for a
            specific media search article.
          type: string
          example: ca6993d5-c4a5-4227-a957-81a76d8279b4
        media_search_execution_id:
          description: >-
            `media_search_execution_id` represents the unique identifier for a
            media search execution.
          type: string
          example: f0549515-ffb9-4dfd-a116-efb4143afda4
        media_search_id:
          description: >-
            `media_search_id` represents the unique identifier for a media
            search.
          type: string
          example: 4ccd19dc-c60b-4ce7-b512-bba106f1cb16
        organisation_id:
          description: >-
            `organisation_id` represents the unique identifier for an
            organisation.
          type: string
          example: d43a4ec2-3eb8-46ad-9ca9-09a26540968f
        risk:
          description: >-
            `risk` represents the risk level associated with a media search
            article.
          type: string
          enum:
            - RISKY
            - NOT_RISKY
        risk_categories:
          description: >-
            `risk_categories` holds an array of strings that represent various
            risk categories associated with a media search article.
          type: array
          items:
            type: string
          example:
            - Fraud
            - Money Laundering
            - Sanctions
            - Human Rights Abuse
            - Terrorism
            - Organized Crime
            - Corruption
            - Tax Crimes
    main.subjectMatch:
      type: object
      properties:
        industry_match:
          type: object
          properties:
            match_score:
              type: integer
              example: 8
            match_type:
              type: string
              example: STRONG_MATCH
            match_type_description:
              type: string
              example: Very similar
            matches:
              type: array
              items:
                type: object
                properties:
                  match_score:
                    type: number
                    example: 8
                  match_type:
                    type: string
                    example: STRONG_MATCH
                  match_type_description:
                    type: string
                    example: Very similar
                  subject_industry:
                    type: string
                    example: Banking
                  subject_industry_article:
                    type: string
                    example: Finance
            subject_industries:
              type: array
              items:
                type: string
              example:
                - Banking
                - Insurance
                - Telecommunications
            subject_industries_article:
              type: array
              items:
                type: string
              example:
                - Banking
                - Finance
                - Telecommunications
        match_score:
          type: number
          example: 7
        match_type:
          type: string
          example: MODERATE_MATCH
        match_type_description:
          type: string
          example: Similar
        nationality_matches:
          type: object
          properties:
            match_score:
              type: number
              example: 7
            match_type:
              type: string
              example: MODERATE_MATCH
            match_type_description:
              type: string
              example: Similar
            matches:
              type: array
              items:
                type: object
                properties:
                  match_score:
                    type: number
                    example: 0
                  match_type:
                    type: string
                    example: TOTAL_MISMATCH
                  match_type_description:
                    type: string
                    example: Not similar at all
                  subject_nationality:
                    type: string
                    example: US
                  subject_nationality_article:
                    type: string
                    example: DE
            subject_nationalities:
              type: array
              items:
                type: string
              example:
                - US
                - GB
            subject_nationalities_article:
              type: array
              items:
                type: string
              example:
                - US
                - DE
        place_matches:
          type: object
          properties:
            match_score:
              type: integer
              example: 7
            match_type:
              type: string
              example: MODERATE_MATCH
            match_type_description:
              type: string
              example: Similar
            matches:
              type: array
              items:
                type: object
                properties:
                  distance:
                    type: object
                    properties:
                      kilometers:
                        type: number
                        example: 1
                      miles:
                        type: number
                        example: 0.621371
                  match_score:
                    type: number
                    example: 7
                  match_type:
                    type: string
                    example: MODERATE_MATCH
                  match_type_description:
                    type: string
                    example: Similar
                  matching_values:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                  subject_article_place_id:
                    type: string
                    example: 12fve345-1234-1234-1234-123456789012
                  subject_place_id:
                    type: string
                    example: 12fve345-1234-1234-1234-123456789012
            subject_places:
              type: array
              items:
                type: object
                properties:
                  description:
                    type: string
                    example: Head Office
                  geo_code_place:
                    type: object
                    properties:
                      lat:
                        type: number
                        example: 40.7128
                      lng:
                        type: number
                        example: -74.006
                  place:
                    type: string
                    example: 123 Main Street, New York, USA
                  place_id:
                    type: string
                    example: 12fve345-1234-1234-1234-123456789012
            subject_places_article:
              type: array
              items:
                type: object
                properties:
                  description:
                    type: string
                    example: Home
                  place:
                    type: string
                    example: 112 Main Street, New York, USA
                  place_id:
                    type: string
                    example: 12fve345-1234-1234-1234-123456789012
        start_date_match:
          type: object
          properties:
            match_score:
              type: number
              example: 10
            match_type:
              type: string
              example: TOTAL_MATCH
            match_type_description:
              type: string
              example: Exact match
            subject_start_date:
              type: string
              example: '1980-04-07T00:00:00.000Z'
            subject_start_date_article:
              type: string
              example: '1980-04-07T00:00:00.000Z'
        type_match:
          type: object
          properties:
            match_score:
              type: number
              example: 10
            match_type:
              type: string
              example: TOTAL_MATCH
            match_type_description:
              type: string
              example: Exact match
            subject_type:
              type: string
              example: INDIVIDUAL
            subject_type_article:
              type: string
              example: INDIVIDUAL

````