# 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://docs.payabli.com/developers/api-reference/vendor/get-basic-statistics-for-a-vendor

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Get basic statistics for a vendor
  version: endpoint_statistic.VendorBasicStats
paths:
  /Statistic/vendorbasic/{mode}/{freq}/{idVendor}:
    get:
      operationId: vendor-basic-stats
      summary: Get basic statistics for a vendor
      description: >-
        Retrieve the basic statistics about a vendor for a given time period,
        grouped by frequency. 
      tags:
        - - subpackage_statistic
      parameters:
        - name: mode
          in: path
          description: |-
            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
          required: true
          schema:
            type: string
        - name: freq
          in: path
          description: |-
            Frequency to group series. Allowed values:

            - `m` - monthly
            - `w` - weekly
            - `d` - daily
            - `h` - hourly

            For example, `w` groups the results by week.
          required: true
          schema:
            type: string
        - name: idVendor
          in: path
          description: Vendor ID.
          required: true
          schema:
            type: integer
        - name: parameters
          in: query
          description: List of parameters
          required: false
          schema:
            type: object
            additionalProperties:
              type: string
        - name: requestToken
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/type_statistic:StatisticsVendorQueryRecord
components:
  schemas:
    type_statistic:StatisticsVendorQueryRecord:
      type: object
      properties:
        statX:
          type: string
          description: Statistical grouping identifier
        active:
          type: integer
          description: Number of active transactions
        activeVolume:
          type: number
          format: double
          description: Volume of active transactions
        sentToApproval:
          type: integer
          description: Number of transactions sent to approval
        sentToApprovalVolume:
          type: number
          format: double
          description: Volume of transactions sent to approval
        toApproval:
          type: integer
          description: Number of transactions to approval
        toApprovalVolume:
          type: number
          format: double
          description: Volume of transactions to approval
        approved:
          type: integer
          description: Number of approved transactions
        approvedVolume:
          type: number
          format: double
          description: Volume of approved transactions
        disapproved:
          type: integer
          description: Number of disapproved transactions
        disapprovedVolume:
          type: number
          format: double
          description: Volume of disapproved transactions
        cancelled:
          type: integer
          description: Number of cancelled transactions
        cancelledVolume:
          type: number
          format: double
          description: Volume of cancelled transactions
        inTransit:
          type: integer
          description: Number of transactions in transit
        inTransitVolume:
          type: number
          format: double
          description: Volume of transactions in transit
        paid:
          type: integer
          description: Number of paid transactions
        paidVolume:
          type: number
          format: double
          description: Volume of paid transactions
      required:
        - statX
        - active
        - activeVolume
        - sentToApproval
        - sentToApprovalVolume
        - toApproval
        - toApprovalVolume
        - approved
        - approvedVolume
        - disapproved
        - disapprovedVolume
        - cancelled
        - cancelledVolume
        - inTransit
        - inTransitVolume
        - paid
        - paidVolume

```

## SDK Code Examples

```python VendorBasicStatsExample
from payabli import payabli

client = payabli(
    api_key="YOUR_API_KEY",
)
client.statistic.vendor_basic_stats(
    freq="m",
    id_vendor=1,
    mode="ytd",
)

```

```typescript VendorBasicStatsExample
import { PayabliClient } from "@payabli/sdk-node";

const client = new PayabliClient({ apiKey: "YOUR_API_KEY" });
await client.statistic.vendorBasicStats("ytd", "m", 1);

```

```go VendorBasicStatsExample
import (
	context "context"
	option "github.com/payabli/sdk-go/option"
	sdkgo "github.com/payabli/sdk-go"
	sdkgoclient "github.com/payabli/sdk-go/client"
)

client := sdkgoclient.NewClient(
	option.WithApiKey(
		"<YOUR_ApiKey>",
	),
)
response, err := client.Statistic.VendorBasicStats(
	context.TODO(),
	"m",
	1,
	"ytd",
	&sdkgo.VendorBasicStatsRequest{},
)

```

```csharp VendorBasicStatsExample
using PayabliApi;

var client = new PayabliApiClient("API_KEY");
await client.Statistic.VendorBasicStatsAsync("m", 1, "ytd", new VendorBasicStatsRequest());

```

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

```php VendorBasicStatsExample
<?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();
```

```swift VendorBasicStatsExample
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()
```