Breeder API

Listing analytics — API reference

How to pull monthly performance statistics for your Herpify listings using the Breeder API.

What it does

The analytics endpoint returns aggregate performance numbers for a given calendar month: how many views, favourites, and inquiries your listings received, how many animals you sold, your average review rating for that period, and your top 5 listings by view count. Optionally, you can scope the results to a single listing if you want to track one animal's performance over time.

Who can access it

Breeder plan subscribers only. Authenticate with your API key in the `Authorization: Bearer` header.

The request — GET /api/breeder/analytics

ParameterTypeRequiredDescription
periodstringRequiredThe month to report on, in YYYY-MM format. E.g. "2026-03" for March 2026.
listingIdstringOptionalOptional. Scope all stats to a single listing. If omitted, stats cover all your listings.

What you'll get back

A summary object for the period with counts, a rating average, and a ranked list of your top 5 listings by views.

Example response for March 2026

{
  "data": {
    "period": "2026-03",
    "listings": {
      "total": 24,
      "byStatus": {
        "ACTIVE": 18,
        "DRAFT": 3,
        "SOLD": 2,
        "EXPIRED": 1,
        "ARCHIVED": 0
      }
    },
    "views": 1284,
    "favourites": 97,
    "inquiries": 23,
    "sold": 2,
    "reviews": {
      "count": 3,
      "averageRating": 5.0
    },
    "topListingsByViews": [
      {
        "id": "clxa1b2c3d4e5f6g7",
        "title": "Banana Pastel Clown Ball Python",
        "views": 412
      },
      {
        "id": "clx9z8y7x6w5v4u3",
        "title": "Pastel Ball Python — Het Clown",
        "views": 214
      },
      {
        "id": "clxc3d4e5f6g7h8i9",
        "title": "Northern Blue-Tongue Skink — CB2025",
        "views": 187
      }
    ]
  }
}

Real-world example

You want a simple monthly report that lands in your inbox on the first of every month. A script runs on a schedule, calls this endpoint with the previous month's YYYY-MM value, formats the numbers into a short email, and sends it to you. No logging in, no exporting — your performance summary delivered automatically.

Was this article helpful?