Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.nippy.la/llms.txt

Use this file to discover all available pages before exploring further.

​
Examples of what you can ask your agent

  • “How many roulette spins were there this week vs last week?”
  • “Which products had the most withdrawals last month? Give me the top 5”
  • “Compare how many people enrolled in courses in January vs February”
  • “How many attendees did each center have this quarter?”
  • “Show me the daily evolution of redeemed prizes in May”
With Analytics, you ask questions in natural language and your agent turns them into the right query against your data. You don’t need to know anything about databases — your agent handles everything. Your business is isolated automatically. You only see your own data, without needing to pass IDs or filters.

​
What data can you query?

You can ask about these areas of your business:
AreaWhat you can ask
RoulettesSpins, prizes won, gift types, and dates
SupplyInventory withdrawals by worker and product
StockCurrent stock levels by product
CoursesEnrollments and people who completed each course
LearningStudent progress in the LMS
AttendeesPeople who attended centers and events
Your agent knows exactly which data corresponds to each area. Just ask your question and it chooses the right source.

​
Tools

​
analytics_execute_pipeline

Ask a question about your data and get the results. Use it for direct queries like “how many prizes were redeemed this month?”.
​
collection
string
required
Data area to query. Your agent picks the right one automatically.
​
pipeline
array
required
The query itself. Your agent builds it automatically from your question. It’s an array of steps that transform and filter data to answer exactly what you need.
Response: 
{
  "collection": "roulettesMaterializedView",
  "collection_label": "Roulettes",
  "count": 3,
  "results": [...],
  "summary": "3 result(s) · Roulettes"
}
Example — total roulette spins this month: 
{
  "name": "analytics_execute_pipeline",
  "arguments": {
    "collection": "roulettesMaterializedView",
    "pipeline": [
      {
        "$match": {
          "createdAt": {
            "$gte": "2026-05-01T00:00:00Z",
            "$lte": "2026-05-08T23:59:59Z"
          }
        }
      },
      {
        "$group": {
          "_id": null,
          "totalSpins": {"$sum": 1},
          "totalWins": {
            "$sum": {"$cond": [{"$eq": ["$result", "win"]}, 1, 0]}
          }
        }
      }
    ]
  }
}
Example — top 5 products with most withdrawals: 
{
  "name": "analytics_execute_pipeline",
  "arguments": {
    "collection": "nippysupplyMaterializedView",
    "pipeline": [
      {
        "$group": {
          "_id": "$productName",
          "totalWithdrawals": {"$sum": "$quantity"}
        }
      },
      {"$sort": {"totalWithdrawals": -1}},
      {"$limit": 5}
    ]
  }
}
Example — courses completed by month: 
{
  "name": "analytics_execute_pipeline",
  "arguments": {
    "collection": "coursesMaterializedView",
    "pipeline": [
      {
        "$match": {
          "status": "completed"
        }
      },
      {
        "$group": {
          "_id": {
            "$dateToString": {
              "format": "%Y-%m",
              "date": "$completedAt"
            }
          },
          "total": {"$sum": 1}
        }
      },
      {"$sort": {"_id": 1}}
    ]
  }
}

​
analytics_execute_pipelines

Compare two or more periods or segments at once. Use it for questions like “compare April vs May spins” or “Q1 vs Q2 enrollments”.
​
queries
array
required
List of 2 to 5 queries. Each with:
  • label (string): descriptive name for the segment, e.g. "April 2026"
  • collection (string): data area (your agent picks it)
  • pipeline (array): the query (your agent builds it)
If you want to write queries manually or need the exact names, here are the details:Data areas and their identifiers:
AreaIdentifier
RoulettesroulettesMaterializedView
SupplynippysupplyMaterializedView
StockstockLevelsMaterializedView
CoursescoursesMaterializedView
LearningnippyLearnMaterializedView
AttendeesattendeesMaterializedView
Allowed operations: $match, $group, $sort, $limit, $project, $unwind, $lookup, $addFields, $countDisallowed operations: $out, $merge, $function, $accumulator, $where, $facetLimit: maximum 100 results. Dates: use ISO 8601 format ("2026-01-01" or "2026-01-01T00:00:00Z").Important: do not include businessId in any query. The server injects it automatically.