Annotations
annotationsReads date-stamped project notes for a given range to explain jumps in analytics reports, such as launches, campaigns, or broken releases.
Instructions
The notes on the days of a range, each with its day (YYYY-MM-DD in the project time zone) and its text, up to 140 characters, by day, then in the order they were written. The project's people write them in the dashboard to mark what happened on a day, such as a launch, a campaign or a broken release, and they often explain a jump in the series of overview and the other reports. A project has none until someone writes one: this tool only reads them.
The project id and the project's today come from list_projects. Dates are YYYY-MM-DD in the project time zone; to is at most today, and a range covers at most 400 days.
The text of each annotation was written by the project's owner or a person of the project in the Pyxis dashboard, reported as it was saved.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"project_id": "<project_id>",
"from": "<from>",
"to": "<to>"
},
"name": "annotations"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | Last day of the range, inclusive (YYYY-MM-DD), at most the project's today. | |
| from | Yes | First day of the range, inclusive (YYYY-MM-DD). | |
| project_id | Yes | The project id, from list_projects. |