Skip to content

docs: clarify created_at timezone in public API guide #2726

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify created_at timezone in public API guide #2726

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions models/track/public-api-guide.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,8 @@ You can filter by using the MongoDB Query Language.

#### Date

`created_at` values are ISO 8601 timestamps in UTC. Use the same format for the bounds:

```python
runs = api.runs(
"<entity>/<project>",
Expand Down Expand Up @@ -528,6 +530,8 @@ run = api.run("entity/project/run_id")
start_time = run.created_at
```

`run.created_at` is an ISO 8601 timestamp in UTC (for example, `"2023-01-01T12:00:00Z"`). The same convention applies to the `created_at` and `updated_at` fields on other public API objects, such as `Registry`, `ArtifactCollection`, and `Project`. Convert to a local timezone with `datetime.fromisoformat(start_time.replace("Z", "+00:00"))` and then `.astimezone()`.

### Upload files to a finished run

The code snippet below uploads a selected file to a finished run.
Expand Down
Loading