---
title: "Creates an TimelineAnalysis"
method: PUT
path: "/timelineAnalysis"
tags: ["timelineAnalysis"]
---

# Creates an TimelineAnalysis

`PUT /timelineAnalysis`

## Request body

- TimelineAnalysisCreate
  - `name` string, required — Name of the TimelineAnalysis
  - `timeline_analysis_type` 'document' | 'sentence_annotation' | 'span_annotation' | 'bbox_annotation', required
  - `project_id` integer, required — Project the TimelineAnalysis belongs to

## Response `200`

Successful Response

- TimelineAnalysisRead
  - `name` string, required — Name of the TimelineAnalysis
  - `timeline_analysis_type` 'document' | 'sentence_annotation' | 'span_annotation' | 'bbox_annotation', required
  - `id` integer, required — ID of the TimelineAnalysis
  - `project_id` integer, required — Project the TimelineAnalysis belongs to
  - `settings` TimelineAnalysisSettings, required
    - `group_by` 'YEAR' | 'MONTH' | 'DAY'
    - `annotation_aggregation_type` 'unit' | 'annotation' | 'document'
    - `date_metadata_id` integer, nullable — ID of the Project Date Metadata that is used for the TimelineAnalysis
  - `concepts` TimelineAnalysisConcept[], required — List of Concepts that are part of the TimelineAnalysis
    - `timeline_analysis_type` 'document' | 'sentence_annotation' | 'span_annotation' | 'bbox_annotation', required
    - `id` string, required — ID of the Concept
    - `name` string, required — Name of the Concept
    - `description` string, required — Description of the Concept
    - `color` string, required — Color of the Concept
    - `visible` boolean, required — Visibility of the Concept
    - `ta_specific_filter` union, required — List of Concepts that are part of the TimelineAnalysis
      - SdocTimelineAnalysisFilterOutput
        - `timeline_analysis_type` 'document', required
        - `filter` FilterSdocColumnsOutput, required
          - `id` string, required
          - `items` union[], required
            - union
              - …
          - `logic_operator` 'or' | 'and', required — This tells our filter how to combine multiple column expressions.
      - SentAnnoTimelineAnalysisFilterOutput
        - `timeline_analysis_type` 'sentence_annotation', required
        - `filter` FilterSentAnnoColumnsOutput, required
          - `id` string, required
          - `items` union[], required
            - union
              - …
          - `logic_operator` 'or' | 'and', required — This tells our filter how to combine multiple column expressions.
      - SpanAnnoTimelineAnalysisFilterOutput
        - `timeline_analysis_type` 'span_annotation', required
        - `filter` FilterSpanColumnsOutput, required
          - `id` string, required
          - `items` union[], required
            - union
              - …
          - `logic_operator` 'or' | 'and', required — This tells our filter how to combine multiple column expressions.
      - BBoxAnnoTimelineAnalysisFilterOutput
        - `timeline_analysis_type` 'bbox_annotation', required
        - `filter` FilterBBoxColumnsOutput, required
          - `id` string, required
          - `items` union[], required
            - union
              - …
          - `logic_operator` 'or' | 'and', required — This tells our filter how to combine multiple column expressions.
    - `filter_hash` integer, required — Hash of the filter to identify changes
    - `results` TimelineAnalysisResult[], required — List of Results of the TimelineAnalysis
      - `date` string, required — The date.
      - `data_ids` integer[], required — The data IDs used for provenance.
      - `count` integer, required — The count / value used for plotting.
  - `created` string, date-time, required — Created timestamp of the TimelineAnalysis
  - `updated` string, date-time, required — Updated timestamp of the TimelineAnalysis

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/uhh-lt/apis/discourse-analysis-tool-suite-api.md) · [All operations](https://skmtc.net/uhh-lt/apis/discourse-analysis-tool-suite-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/uhh-lt/discourse-analysis-tool-suite-api/revisions/6b22366ce2d1/schema)