1. Reports
Tjar
  • 🗂️ Overview
  • 🚀 Start Here
  • Orders
    • List Orders
      GET
    • Get Order Details
      GET
    • Order Statuses
      GET
    • Create Order
      POST
    • Change Order Status
      POST
  • Products
    • Digital
      • Create Digital Product
      • Get Digital Product Details
      • Update Digital Product
    • Booking
      • Get Booking Product Details
      • Create Booking Product
      • Update Booking Product
    • Service
      • Get Service Product
      • Create Service Product
      • Update Service Product
    • Physical
      • Get Physical Product Details
      • Create Physical Product
      • Update Physical Product
    • List All Products
      GET
    • Get Product Details
      GET
    • Delete Product
      DELETE
  • Media
    • Upload Media
      POST
    • Upload Multiple Media
      POST
    • Update Media
      POST
  • Webhook
    • Events
      • Cart Abandoned
      • Order Created
      • Order Created
      • Order Status Changed
      • Order Updated
      • Product Created
      • Product Deleted
      • Product Updated
      • Product Review Submitted
      • Product Stock Update
      • Customer Created
      • Customer Updated
      • Customer Login
      • Customer Welcome
      • Customer OTP Sent
      • Category Created
      • Category Updated
      • Category Deleted
      • Brand Created
      • Brand Updated
      • Brand Deleted
    • List Webhooks
      GET
    • Register Webhook
      POST
    • Update Webhook
      PUT
    • Delete Webhook
      DELETE
    • Verify Signature
      POST
    • Refresh Secret
      POST
    • Webhook Events
      GET
  • Abandoned Cart
    • List Abandoned Carts
    • Get Abandoned Cart Details
    • Send Reminder
  • Articles / Blog
    • List Articles
    • Get Article Details
    • List Article Categories
    • Create Article
    • Update Article with New Image File
    • Update Article
    • Delete Article
  • Reports
    • Visits report
      GET
  • Schemas
    • MediaImage
    • VisitsReportResponse
    • ArticleCategory
    • VisitsReportData
    • ArticleSeo
    • AudienceItem
    • Article
    • Pagination
    • ArticleListResponse
    • ArticleCategoryListResponse
    • ArticleResponse
    • DeleteArticleResponse
    • CreateArticleJsonRequest
    • CreateArticleMultipartRequest
    • UpdateArticleJsonRequest
    • UpdateArticleMultipartRequest
  1. Reports

Visits report

GET
/report/visits
Last modified:2026-10-14 15:22:20
Returns visits analytics for a date range. Range comes from start_date+end_date, or a preset. Defaults to last 30 days. Cached 30 minutes.

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params

Header Params

Responses

🟢200
application/json
Visits report returned successfully
Bodyapplication/json

🟠400
🟠403
🟠422
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/report/visits?preset=undefined&start_date=undefined&end_date=undefined' \
--header 'Accept: application/json' \
--header 'Accept-Language: {{lang}}' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - Success
{
    "status": "success",
    "message": "Visits report returned successfully",
    "data": {
        "start_date": "2026-09-15",
        "end_date": "2026-10-14",
        "stats": {
            "visitors": 128,
            "events": 340,
            "duration": "3m 42s"
        },
        "top_pages": [
            {
                "name": "Home",
                "url": "/",
                "views": 120,
                "percent": 100
            },
            {
                "name": "Product",
                "url": "/product/some-slug",
                "views": 60,
                "percent": 50
            }
        ],
        "map_data": [
            {
                "id": "SA",
                "value": 90
            },
            {
                "id": "AE",
                "value": 12
            }
        ],
        "audience": {
            "browsers": [
                {
                    "browser": "Chrome",
                    "unique_users": 80
                }
            ],
            "devices": [
                {
                    "device_type": "mobile",
                    "unique_users": 100
                }
            ],
            "os": [
                {
                    "os": "Android",
                    "unique_users": 70
                }
            ]
        },
        "summary": "AI-generated text summary of the period"
    }
}
Modified at 2026-10-14 15:22:20
Previous
Delete Article
Next
MediaImage
Built with