Get Tool State Timeseries

from atomscale import Client

client = Client(api_key="YOUR_API_KEY")
results = client.get(data_ids="d290f1ee-6c54-4b01-90e6-d701748f0851")
tool_state = results[0]  # ToolStateResult
print(tool_state.timeseries_data)

import requests

response = requests.get(
    "https://api.atomscale.ai/tool-state/d290f1ee-6c54-4b01-90e6-d701748f0851/timeseries/",
    headers={"X-API-KEY": "YOUR_API_KEY"}
)
tool_state_data = response.json()

curl "https://api.atomscale.ai/tool-state/d290f1ee-6c54-4b01-90e6-d701748f0851/timeseries/" \
  -H "X-API-KEY: YOUR_API_KEY"

{
  "properties": {
    "thickness": {
      "relative_time_seconds": [0, 10, 20, 30, 40, 50],
      "unix_timestamp_ms": [1705312200000, 1705312210000, 1705312220000, 1705312230000, 1705312240000, 1705312250000],
      "values": [0, 5.2, 10.1, 15.3, 20.0, 25.1],
      "units": "nm"
    },
    "deposition_rate": {
      "relative_time_seconds": [0, 10, 20, 30, 40, 50],
      "unix_timestamp_ms": [1705312200000, 1705312210000, 1705312220000, 1705312230000, 1705312240000, 1705312250000],
      "values": [0.52, 0.49, 0.52, 0.47, 0.51, 0.50],
      "units": "nm/s"
    }
  },
  "series_max_time": 50.0
}

GET

tool-state

{data_id}

timeseries

from atomscale import Client

client = Client(api_key="YOUR_API_KEY")
results = client.get(data_ids="d290f1ee-6c54-4b01-90e6-d701748f0851")
tool_state = results[0]  # ToolStateResult
print(tool_state.timeseries_data)

import requests

response = requests.get(
    "https://api.atomscale.ai/tool-state/d290f1ee-6c54-4b01-90e6-d701748f0851/timeseries/",
    headers={"X-API-KEY": "YOUR_API_KEY"}
)
tool_state_data = response.json()

curl "https://api.atomscale.ai/tool-state/d290f1ee-6c54-4b01-90e6-d701748f0851/timeseries/" \
  -H "X-API-KEY: YOUR_API_KEY"

{
  "properties": {
    "thickness": {
      "relative_time_seconds": [0, 10, 20, 30, 40, 50],
      "unix_timestamp_ms": [1705312200000, 1705312210000, 1705312220000, 1705312230000, 1705312240000, 1705312250000],
      "values": [0, 5.2, 10.1, 15.3, 20.0, 25.1],
      "units": "nm"
    },
    "deposition_rate": {
      "relative_time_seconds": [0, 10, 20, 30, 40, 50],
      "unix_timestamp_ms": [1705312200000, 1705312210000, 1705312220000, 1705312230000, 1705312240000, 1705312250000],
      "values": [0.52, 0.49, 0.52, 0.47, 0.51, 0.50],
      "units": "nm/s"
    }
  },
  "series_max_time": 50.0
}

Returns tool state timeseries data, such as instrument sensor readbacks. Data is organized by property name, where each property has its own arrays of timestamps and values, allowing different sampling rates per property.

string

required

The data entry UUID for the tool state data

boolean

default:"false"

If true, returns null instead of an error when no timeseries data exists for this entry

number

Only return data points after this elapsed time (seconds). Useful for incremental fetching during live monitoring.

array

If set, only these property columns are returned. Omit to return all properties.

boolean

default:"false"

If true, skip the data and return a metadata-only response listing the available properties

Response

object

Mapping of property names to their timeseries data. Each key is a property name (e.g., thickness, temperature).

Show properties

array

Array of time values relative to the start of the measurement (seconds)

array

Array of Unix timestamps in milliseconds

array

Array of measurement values

string

Measurement unit for the values (e.g., nm, C)

number

Maximum relative_time_seconds value across all properties

from atomscale import Client

client = Client(api_key="YOUR_API_KEY")
results = client.get(data_ids="d290f1ee-6c54-4b01-90e6-d701748f0851")
tool_state = results[0]  # ToolStateResult
print(tool_state.timeseries_data)

import requests

response = requests.get(
    "https://api.atomscale.ai/tool-state/d290f1ee-6c54-4b01-90e6-d701748f0851/timeseries/",
    headers={"X-API-KEY": "YOUR_API_KEY"}
)
tool_state_data = response.json()

curl "https://api.atomscale.ai/tool-state/d290f1ee-6c54-4b01-90e6-d701748f0851/timeseries/" \
  -H "X-API-KEY: YOUR_API_KEY"

{
  "properties": {
    "thickness": {
      "relative_time_seconds": [0, 10, 20, 30, 40, 50],
      "unix_timestamp_ms": [1705312200000, 1705312210000, 1705312220000, 1705312230000, 1705312240000, 1705312250000],
      "values": [0, 5.2, 10.1, 15.3, 20.0, 25.1],
      "units": "nm"
    },
    "deposition_rate": {
      "relative_time_seconds": [0, 10, 20, 30, 40, 50],
      "unix_timestamp_ms": [1705312200000, 1705312210000, 1705312220000, 1705312230000, 1705312240000, 1705312250000],
      "values": [0.52, 0.49, 0.52, 0.47, 0.51, 0.50],
      "units": "nm/s"
    }
  },
  "series_max_time": 50.0
}

Introduction

Data Catalogue

Data Upload

Projects

Physical Samples

RHEED

SEM

Spectroscopy

OES

SIMS

Optical

Tool State

Tags

Target Materials

Instruments

Response

​Response

Response