> For the complete documentation index, see [llms.txt](https://docs.trybit.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.trybit.com/api-reference-v2/statistics.md).
# Statistics
### What the method allows you to do
* Returns statistics on invoice statuses for the specified period.
### Endpoint
`POST` `https://api.trybit.com/v2/invoice/merchant/statistics`
### Headers
| Name | Type | Example | Description |
| ----------------------------------------------- | ------ | ----------------------------------- | --------------- |
| Authorization\* | string | Token eyJ0eXAiOiJK<...>4npi1ksS8tSY | Project API key |
### Request Body
Key parameters
| Name | Type | Example | Description |
| --------------------------------------- | ------ | ---------- | ------------------------------------------------------------------------------------------------------------ |
| start\* | string | 01.01.2026 | Date in format `«dd.mm.yyyyy»` |
| end\* | string | 31.01.2026 | Date in format «dd.mm.yyyyy»
Must be greater than or equal to start.
|
### Request examples
These examples show how to send a request to retrieve statistics on invoice statuses for the specified period.
{% tabs %}
{% tab title="cURL" %}
```bash
curl -X POST https://api.trybit.com/v2/invoice/merchant/statistics \
-H "Authorization: Token " \
-H "Content-Type: application/json" \
-d '{"start":"01.01.2023","end":"31.01.2023"}'
```
{% endtab %}
{% tab title="Python" %}
```python
import requests
url = "https://api.trybit.com/v2/invoice/merchant/statistics"
headers = {
"Authorization": "Token "
}
data = {
"start": "01.01.2023",
"end": "31.01.2023"
}
response = requests.post(url, headers=headers, json=data)
if response.status_code == 200:
print("Success:", response.json())
else:
print("Fail:", response.status_code, response.text)
```
{% endtab %}
{% tab title="JavaScript" %}
```javascript
fetch('https://api.trybit.com/v2/invoice/merchant/statistics', {
method: 'POST',
headers: {
'Authorization': 'Token ',
'Content-Type': 'application/json'
},
body: JSON.stringify({
start: '01.01.2023',
end: '31.01.2023'
})
})
.then(response => {
if (response.ok) {
return response.json();
} else {
throw new Error('Fail: ' + response.status + ' ' + response.statusText);
}
})
.then(data => console.log('Success:', data))
.catch(error => console.error('Error:', error));
```
{% endtab %}
{% tab title="PHP" %}
```php
"01.01.2023",
"end" => "31.01.2023"
)));
$headers = array(
"Authorization: Token ",
"Content-Type: application/json"
);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$response = curl_exec($ch);
if (curl_errno($ch)) {
echo 'Error:' . curl_error($ch);
} else {
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if ($statusCode == 200) {
echo "Success: " . $response;
} else {
echo "Fail: " . $statusCode . " " . $response;
}
}
curl_close($ch);
?>
```
{% endtab %}
{% endtabs %}
### Response examples
A successful request returns a response with the status `success` and a `result` object.
{% tabs %}
{% tab title="200: OK – Statistics" %}
```json
{
"status": "success",
"result": {
"count": {
"all": 907,
"created": 4,
"paid": 90,
"overpaid": 8,
"partial": 6,
"canceled": 799
},
"amount": {
"all": 214356.22712,
"created": 4.0,
"paid": 629.729137,
"overpaid": 36.82,
"partial": 11.4,
"canceled": 213674.277983
}
}
}
```
{% endtab %}
{% endtabs %}
### Response parameters
The `result` object contains:
| Name | Type | Example | Description |
| -------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- |
| count | dict | "count": {
"all": 907,
"created": 4,
"paid": 90,
"overpaid": 8,
"partial": 6,
"canceled": 799
}
| Object containing values for the number of invoices |
| amount | dict | "amount": {
"all": 214356.22712,
"created": 4.0,
"paid": 629.729137,
"overpaid": 36.82,
"partial": 11.4,
"canceled": 213674.277983
}
| Object containing values for amounts in USD |
| all | int, float | 907 / 214356.22712 | All invoices |
| created | int, float | 4 / 4.0 | Invoices with the “Created” status |
| paid | int, float | 90 / 629.729137 | Invoices with the “Paid” status |
| overpaid | int, float | 8 / 36.82 | Invoices with the “Overpaid” status |
| partial | int, float | 6 / 11.4 | Invoices with the “Partially paid” status |
| canceled | int, float | 799 / 213674.277983 | Invoices with the “Canceled” status |
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.trybit.com/api-reference-v2/statistics.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.