> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://beta-docs.payabli.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://beta-docs.payabli.com/_mcp/server.

# Get vendor stats

GET https://api-sandbox.payabli.com/api/Statistic/vendorbasic/{mode}/{freq}/{idVendor}

Retrieve the basic statistics about a vendor for a given time period, grouped by frequency. 

Reference: https://beta-docs.payabli.com/api-reference/vendor/get-basic-statistics-for-a-vendor

## Authentication

- `requestToken` header (required) — API Key authentication via header

## Servers

- `https://api-sandbox.payabli.com/api` (Sandbox, default)
- `https://api.payabli.com/api` (Production)

## Request

### Path parameters

- `freq` (string, required) — Frequency to group series. Allowed values: - `m` - monthly - `w` - weekly - `d` - daily - `h` - hourly For example, `w` groups the results by week.
- `idVendor` (integer, required) — Vendor ID.
- `mode` (string, required) — Mode for request. Allowed values: - `ytd` - Year To Date - `mtd` - Month To Date - `wtd` - Week To Date - `today` - All current day - `m12` - Last 12 months - `d30` - Last 30 days - `h24` - Last 24 hours - `lasty` - Last Year - `lastm` - Last Month - `lastw` - Last Week - `yesterday` - Last Day

### Query parameters

- `parameters` (map from string to string, optional) — List of parameters

## Response

### 200

Success

- `list of StatisticsVendorQueryRecord`

## Errors

### 400 Bad Request Error

Bad request/ invalid data

- `any`

### 401 Unauthorized Error

Unauthorized request.

- `any`

### 500 Internal Server Error

Internal API Error

- `any`

### 503 Service Unavailable Error

Database connection error

- `isSuccess` (boolean, optional) — Boolean indicating whether the operation was successful. A `true` value indicates success. A `false` value indicates failure.
- `responseData` (map from string to any, optional) — The object containing the response data.
- `responseText` (string, optional) — Response text for operation: 'Success' or 'Declined'.

## Types

### StatisticsVendorQueryRecord

- `active` (integer, optional)
- `activeVolume` (double, optional)
- `approved` (integer, optional)
- `approvedVolume` (double, optional)
- `cancelled` (integer, optional)
- `cancelledVolume` (double, optional)
- `disapproved` (integer, optional)
- `disapprovedVolume` (double, optional)
- `inTransit` (integer, optional)
- `inTransitVolume` (double, optional)
- `paid` (integer, optional)
- `paidVolume` (double, optional)
- `sentToApproval` (integer, optional)
- `sentToApprovalVolume` (double, optional)
- `statX` (string, optional)
- `toApproval` (integer, optional)
- `toApprovalVolume` (double, optional)

## Examples

**Response**

```json
[
  {
    "active": 1,
    "activeVolume": 1.1,
    "approved": 1,
    "approvedVolume": 1.1,
    "cancelled": 1,
    "cancelledVolume": 1.1,
    "disapproved": 1,
    "disapprovedVolume": 1.1,
    "inTransit": 1,
    "inTransitVolume": 1.1,
    "paid": 1,
    "paidVolume": 1.1,
    "sentToApproval": 1,
    "sentToApprovalVolume": 1.1,
    "statX": "",
    "toApproval": 1,
    "toApprovalVolume": 1.1
  }
]
```

**SDK Code**

```python
import requests

url = "https://api-sandbox.payabli.com/api/Statistic/vendorbasic/ytd/m/1"

headers = {"requestToken": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api-sandbox.payabli.com/api/Statistic/vendorbasic/ytd/m/1';
const options = {method: 'GET', headers: {requestToken: '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.payabli.com/api/Statistic/vendorbasic/ytd/m/1"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("requestToken", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.payabli.com/api/Statistic/vendorbasic/ytd/m/1")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["requestToken"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api-sandbox.payabli.com/api/Statistic/vendorbasic/ytd/m/1")
  .header("requestToken", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api-sandbox.payabli.com/api/Statistic/vendorbasic/ytd/m/1', [
  'headers' => [
    'requestToken' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api-sandbox.payabli.com/api/Statistic/vendorbasic/ytd/m/1");
var request = new RestRequest(Method.GET);
request.AddHeader("requestToken", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["requestToken": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Statistic/vendorbasic/ytd/m/1")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```