# Get customer stats

GET https://api-sandbox.payabli.com/api/Statistic/customerbasic/{mode}/{freq}/{customerId}

Retrieves the basic statistics for a customer for a specific time period, grouped by a selected frequency. 

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

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: Get basic statistics for a customer
  version: endpoint_statistic.CustomerBasicStats
paths:
  /Statistic/customerbasic/{mode}/{freq}/{customerId}:
    get:
      operationId: customer-basic-stats
      summary: Get basic statistics for a customer
      description: >-
        Retrieves the basic statistics for a customer for a specific time
        period, grouped by a selected 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: customerId
          in: path
          description: >-
            Payabli-generated customer ID. Maps to "Customer ID" column in
            PartnerHub. 
          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:SubscriptionStatsQueryRecord
        '400':
          description: Bad request/ invalid data
          content: {}
        '401':
          description: Unauthorized request.
          content: {}
        '500':
          description: Internal API Error
          content: {}
        '503':
          description: Database connection error
          content: {}
components:
  schemas:
    type_statistic:SubscriptionStatsQueryRecord:
      type: object
      properties:
        interval:
          type: string
          description: Time interval identifier
        count:
          type: integer
          description: Number of subscriptions
        volume:
          type: number
          format: double
          description: Subscription volume
      required:
        - interval
        - count
        - volume

```

## SDK Code Examples

```python CustomerBasicStatsExample
from payabli import payabli

client = payabli(
    api_key="YOUR_API_KEY",
)
client.statistic.customer_basic_stats(
    customer_id=998,
    freq="m",
    mode="ytd",
)

```

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

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

```

```go CustomerBasicStatsExample
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.CustomerBasicStats(
	context.TODO(),
	998,
	"m",
	"ytd",
	&sdkgo.CustomerBasicStatsRequest{},
)

```

```csharp CustomerBasicStatsExample
using PayabliApi;

var client = new PayabliApiClient("API_KEY");
await client.Statistic.CustomerBasicStatsAsync(998, "m", "ytd", new CustomerBasicStatsRequest());

```

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

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

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

```php CustomerBasicStatsExample
<?php

$client = new \GuzzleHttp\Client();

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

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

```swift CustomerBasicStatsExample
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api-sandbox.payabli.com/api/Statistic/customerbasic/ytd/m/998")! 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()
```