Skip to content

Commit

Permalink
Update API docs (#11581)
Browse files Browse the repository at this point in the history
**Which issue(s) this PR fixes**:
Fixes #11565
  • Loading branch information
JStickler authored Jan 5, 2024
1 parent 44b8174 commit e1a8141
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/sources/reference/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,10 @@ The API accepts several formats for timestamps:
* A floating point number is a Unix timestamp with fractions of a second.
* A string in `RFC3339` and `RFC3339Nano` format, as supported by Go's [time](https://pkg.go.dev/time) package.

{{% admonition type="note" %}}
When using `/api/v1/push`, you must send the timestamp as a string and not a number, otherwise the endpoint will return a 400 error.
{{% /admonition %}}

### Statistics

Query endpoints such as `/loki/api/v1/query` and `/loki/api/v1/query_range` return a set of statistics about the query execution. Those statistics allow users to understand the amount of data processed and at which speed.
Expand Down

0 comments on commit e1a8141

Please sign in to comment.