# Get User Dashboard Metrics with Weekly Tracking

GET /api/v1/metrics/dashboard/

Retrieve comprehensive metrics for the authenticated user's dashboard with weekly activity tracking.

Each metric includes:
- **total**: All-time count or rate
- **this_week**: Count or rate for the last 7 days
- **percentage**: What portion of total is from this week (or percentage point change for rates)

Metrics tracked:
- AI Studios (publications owned)
- AI Experiences (excluding fully published drafts)
- Followers
- Game completion rate (percentage)
- Completed quests (unique quests)
- AI Expert chat sessions
- AI Notes (blogs created)

Reference: https://docs.aisquare.studio/api-reference/ai-square-studio-api/metrics/dashboard-retrieve

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: AISquare Studio API
  version: 1.0.0
paths:
  /api/v1/metrics/dashboard/:
    get:
      operationId: dashboard-retrieve
      summary: Get User Dashboard Metrics with Weekly Tracking
      description: >-
        Retrieve comprehensive metrics for the authenticated user's dashboard
        with weekly activity tracking.


        Each metric includes:

        - **total**: All-time count or rate

        - **this_week**: Count or rate for the last 7 days

        - **percentage**: What portion of total is from this week (or percentage
        point change for rates)


        Metrics tracked:

        - AI Studios (publications owned)

        - AI Experiences (excluding fully published drafts)

        - Followers

        - Game completion rate (percentage)

        - Completed quests (unique quests)

        - AI Expert chat sessions

        - AI Notes (blogs created)
      tags:
        - subpackage_metrics
      responses:
        '200':
          description: Dashboard metrics retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/metrics_dashboardRetrieve_Response_200'
        '401':
          description: Unauthorized - authentication required
          content:
            application/json:
              schema:
                description: Any type
components:
  schemas:
    metrics_dashboardRetrieve_Response_200:
      type: object
      properties: {}
      description: Empty response body
      title: metrics_dashboardRetrieve_Response_200

```

## SDK Code Examples

```python
import requests

url = "https://api.example.com/api/v1/metrics/dashboard/"

payload = {}
headers = {"Content-Type": "application/json"}

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

print(response.json())
```

```javascript
const url = 'https://api.example.com/api/v1/metrics/dashboard/';
const options = {method: 'GET', headers: {'Content-Type': 'application/json'}, body: '{}'};

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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/metrics/dashboard/"

	payload := strings.NewReader("{}")

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

	req.Header.Add("Content-Type", "application/json")

	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.example.com/api/v1/metrics/dashboard/")

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

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request.body = "{}"

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.example.com/api/v1/metrics/dashboard/")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.example.com/api/v1/metrics/dashboard/', [
  'body' => '{}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.example.com/api/v1/metrics/dashboard/");
var request = new RestRequest(Method.GET);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.example.com/api/v1/metrics/dashboard/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

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