---
title: "Time Series: Client API Overview"
url: "https://docs.ravendb.net/6.2/document-extensions/timeseries/client-api/overview"
version: "6.2"
language: "csharp"
---

# Time Series: Client API Overview

> Client language: C#. Also available for [Node.js](https://docs.ravendb.net/6.2/document-extensions/timeseries/client-api/overview.nodejs.md).
>
> RavenDB publishes an official agent skill for coding assistants at https://docs.ravendb.net/skills/ravendb/SKILL.md (also installable with `npx skills add ravendb/skills`). The skill describes itself as: "Read this before writing any RavenDB query, client call or /databases/ request. Covers server setup, document modelling, the Node.js, .NET and Python clients, RQL, indexes, vector search and AI agents. Code written from recall tends to run and return the wrong rows, because RQL resembles SQL and the clients take field names as plain strings."

> **Note**
>
> The Time Series client API includes a set of [session](https://docs.ravendb.net/6.2/client-api/session/what-is-a-session-and-how-does-it-work.md)
> methods and [store](https://docs.ravendb.net/6.2/client-api/what-is-a-document-store.md)
> [operations](https://docs.ravendb.net/6.2/client-api/operations/what-are-operations.md).  
> You can use the API to **append** (create and update), **get**,
> **delete**, **include**, **patch** and **query** time series data.
>
> - In this page:
>   - [Creating and Removing Time Series](#creating-and-removing-time-series)
>   - [`session` Methods -vs- `document-store` Operations](#session-methods--vs--document-store-operations)
>   - [Available Time Series `session` methods](#available-time-series-session-methods)
>   - [Available Time Series `store` Operations](#available-time-series-store-operations)

## Creating and Removing Time Series

A time series is constructed of time series **entries**, which can
be created and deleted using the API.  
There is no need to explicitly create or delete a time series:

- A time series is created when the first entry is appended to it.
- A time series is deleted when all entries are deleted from it.

## `session` Methods -vs- `document-store` Operations

Some time series functions are available through both `session` methods
and `document-store` operations:  
You can **append**, **delete**, **get** and **patch** time series data
through both interfaces.  
There are also functionalities unique to each interface.

- **Time series functionalities unique to the `session`interface**:
  - `session` methods provide a **transactional guarantee**.  
    Use them when you want to guarantee that your actions would
    be processed in a [single ACID transaction](https://docs.ravendb.net/6.2/client-api/faq/transaction-support.md).  
    You can, for instance, gather multiple session actions
    (e.g. the update of a time series and the modification
    of a document) and execute them in a single transaction
    by calling `session.SaveChanges`, to ensure that they
    would all be completed or all be reverted.
  - You can use `session` methods to `include` time series while
    loading documents.  
    Included time series data is held by the client's session,
    and can be handed to the user instantly when requested
    without issuing an additional request to the server
- **Time series functionalities unique to the `store`interface**:
  - Getting the data of **multiple time series** in a single operation.
  - Managing time series **rollup and retention policies**.
  - Patching time series data to **multiple documents** located by a query.

## Available Time Series `session` methods

- [TimeSeriesFor.Append](https://docs.ravendb.net/6.2/document-extensions/timeseries/client-api/session/append.md)  
  Use this method to **Append entries to a time series**
  (creating the series if it didn't previously exist).
- [TimeSeriesFor.Delete](https://docs.ravendb.net/6.2/document-extensions/timeseries/client-api/session/delete.md)  
  Use this method to **delete a range of entries from a time series**
  (removing the series completely if all entries have been deleted).
- [TimeSeriesFor.Get](https://docs.ravendb.net/6.2/document-extensions/timeseries/client-api/session/get/get-entries.md)  
  Use this method to **Retrieve raw time series entries**
  for all entries or for a chosen entries range.
- [Advanced.GetTimeSeriesFor](https://docs.ravendb.net/6.2/document-extensions/timeseries/client-api/session/get/get-names.md)  
  Use this method to **Retrieve time series Names**.  
  Series names are fetched by `GetTimeSeriesFor` directly from their parent documents'
  metadata, requiring no additional server roundtrips.
- [session.Advanced.Defer](https://docs.ravendb.net/6.2/document-extensions/timeseries/client-api/session/patch.md)  
  Use this method to **patch time series data to a document**.
- **To include time series data** -
  - [Use IncludeTimeSeries while loading a document via session.Load](https://docs.ravendb.net/6.2/document-extensions/timeseries/client-api/session/include/with-session-load.md)
  - [Use IncludeTimeSeries while retrieving a document via session.Query](https://docs.ravendb.net/6.2/document-extensions/timeseries/client-api/session/include/with-session-query.md)
  - [Use RQL while running a raw query](https://docs.ravendb.net/6.2/document-extensions/timeseries/client-api/session/include/with-raw-queries.md)

## Available Time Series `store` Operations

- [TimeSeriesBatchOperation](https://docs.ravendb.net/6.2/document-extensions/timeseries/client-api/operations/append-and-delete.md)  
  Use this operation to **append and delete time series entries**.  
  You can bundle a series of Append and/or Delete operations in a list and
  execute them in a single call.
- [GetTimeSeriesOperation](https://docs.ravendb.net/6.2/document-extensions/timeseries/client-api/operations/get.md#gettimeseriesoperation)  
  Use this operation to Get entries from a single time series.
- [GetMultipleTimeSeriesOperation](https://docs.ravendb.net/6.2/document-extensions/timeseries/client-api/operations/get.md#getmultipletimeseriesoperation)  
  Use this operation to Get entries from multiple time series.
- [ConfigureTimeSeriesOperation](https://docs.ravendb.net/6.2/document-extensions/timeseries/rollup-and-retention.md)  
  Use this operation to **manage time series roll-up and retention policies**.
- [PatchOperation](https://docs.ravendb.net/6.2/document-extensions/timeseries/client-api/operations/patch.md#patchoperation)  
  Use this operation to append/delete time series entries to/from a single document.
- [PatchByQueryOperation](https://docs.ravendb.net/6.2/document-extensions/timeseries/client-api/operations/patch.md#patchbyqueryoperation)  
  Use this operation to run a query and append/delete time series entries to/from
  matching documents.
- [BulkInsert.TimeSeriesFor.Append](https://docs.ravendb.net/6.2/document-extensions/timeseries/client-api/bulk-insert/append-in-bulk.md)  
  Use this operation to append time series entries in bulk.

## See also

- [Time Series Overview](https://docs.ravendb.net/6.2/document-extensions/timeseries/overview.md)
- [Studio Time Series Management](https://docs.ravendb.net/6.2/studio/database/document-extensions/time-series.md)
- [Time Series Settings View](https://docs.ravendb.net/6.2/studio/database/settings/time-series-settings.md)
- [Time Series Querying](https://docs.ravendb.net/6.2/document-extensions/timeseries/querying/overview-and-syntax.md)
- [Time Series Indexing](https://docs.ravendb.net/6.2/document-extensions/timeseries/indexing.md)
- [Time Series Rollup and Retention](https://docs.ravendb.net/6.2/document-extensions/timeseries/rollup-and-retention.md)
