Skip to content

Commit f529619

Browse files
committed
feat: update docs
1 parent bf2413f commit f529619

File tree

1 file changed

+8
-13
lines changed

1 file changed

+8
-13
lines changed

pages/public-api.mdx

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -87,19 +87,14 @@ Response:
8787
GET https://api.postiz.com/public/v1/posts
8888
```
8989

90-
Query:
91-
| Name | Type | Value |
92-
| --- | --- | --- |
93-
| display | string | day \| week \| month |
94-
| day | number | 0-6 |
95-
| week | number | 1-52 |
96-
| month | number | 1-12 |
97-
| year | number | 2022+ |
98-
99-
** day is required if display is day<br />
100-
** week is required if display is week or day<br />
101-
** month is required if display is month or week<br />
102-
** year is required<br /><br />
90+
Payload
91+
```json
92+
{
93+
"startDate": "UTC date in ISO format - ex. 2024-12-14T08:18:54.274Z",
94+
"endDate": "UTC date in ISO format - ex. 2024-12-14T08:18:54.274Z",
95+
"customer"?: "optional customer id for filtering"
96+
}
97+
```
10398

10499
Response:
105100

0 commit comments

Comments
 (0)