Delete Data

Overview

  • This set of api endpoints allows a range of data to be deleted out of the database. A start and end date, as well as a series are required (id or key). As with the read api, the date range is inclusive of the start datetime and exclusive of the end datetime. i.e. [start, end)

  • Operations

    The following delete-related operations are supported:

    • Delete Data by ID
    • Delete Data by Key

  • Single DataPoint Delete

    The following set of API calls takes a datetime range (specified with start and end querystring parameters). Specifying the start and end datetime to the same instant will delete a single DataPoint.

Delete Data by ID

  • Description

    Deletes a range of data from a series referenced by id.

  • Resource URL

    DELETE /series/id/{id}/data/

  • URL Parameters

    • idrequired

      Specifies the id of the series to delete data.

      Example Values: 01868c1a2aaf416ea6cd8edd65e7a4b8

  • Querystring parameters

    • startrequired

      Specifies the start date of the dataset. (ISO8601, inclusive)

      Example Values: 2012-01-08T00:21:54.000+0000

    • endrequired

      Specifies the end date of the dataset. (ISO8601, exclusive)

      Example Values: 2012-01-09T00:21:54.000+0000

  • Request Body

    None

  • Response

    A 200 OK if the request completes.

  • Side Effects

    Data within the range is deleted permanently.

  • Example Request

    delete/series/id/01868c1a2aaf416ea6cd8edd65e7a4b8/data/?start=2012-01-08&end=2012-01-09

Delete Data by Key

  • Description

    Deletes a range of data from a series referenced by key.

  • Resource URL

    DELETE /series/key/{key}/data/

  • URL Parameters

    • key

      Specifies the key of the series to delete data.

      Example Values: my-custom-key

  • Querystring parameters

    • startrequired

      Specifies the start date of the dataset. (ISO8601, inclusive)

      Example Values: 2012-01-08T00:21:54.000+0000

    • endrequired

      Specifies the end date of the dataset. (ISO8601, exclusive)

      Example Values: 2012-01-09T00:21:54.000+0000

  • Request Body

    None

  • Response

    A 200 OK if the request completes.

  • Side Effects

    Data within the range is deleted permanently.

  • Example Request

    delete/series/key/key1/data/?start=2012-01-08&end=2012-01-09