Instasent · Schema

ResponseSegmentItem

Segment entity

CompanyMessagingSMSRCSWhatsAppArtificial IntelligenceMarketing

Properties

Name Type Description
contacts object The segment's cached size. Present on every segment view and on the list endpoints, which serve what the cache already holds and never compute. **Null means the size is not known yet**, not that the s
totalContacts integernull The same number as `contacts.count`, kept for existing clients. Prefer `contacts`, which carries the age of the figure; a bare total invites reading a cached number as a live one.
View JSON Schema on GitHub

JSON Schema

instasent-response-segment-item-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/instasent/json-schema/instasent-response-segment-item-schema.json",
  "title": "ResponseSegmentItem",
  "description": "Segment entity",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/instasent-segment-api-openapi.yml#/components/schemas/ResponseSegmentItem",
  "type": "object",
  "properties": {
    "contacts": {
      "allOf": [
        {
          "$ref": "#/$defs/SegmentContacts"
        }
      ],
      "description": "The segment's cached size. Present on every segment view and on the list\nendpoints, which serve what the cache already holds and never compute.\n**Null means the size is not known yet**, not that the segment is empty:\na listing returns null for any segment whose size has never been\ncomputed or has expired, and the single-segment view computes it. Always\nnull for parameterized dynamic segments.\n"
    },
    "totalContacts": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The same number as `contacts.count`, kept for existing clients. Prefer\n`contacts`, which carries the age of the figure; a bare total invites\nreading a cached number as a live one.\n"
    }
  },
  "additionalProperties": true,
  "x-stoplight": {
    "id": "1td95mbeye75x"
  },
  "$defs": {
    "SegmentContacts": {
      "type": "object",
      "description": "A segment's size as served from the segment-size cache, with its age. Never a\nlive count: the number is computed when someone looks at the segment and then\ncached, with a TTL that grows with the segment's size, so always narrate it with\nits age rather than as a current total.\n",
      "properties": {
        "count": {
          "type": "integer",
          "description": "Number of contacts in the segment when it was computed."
        },
        "computedAt": {
          "type": "string",
          "format": "date-time",
          "description": "When the number was computed, ISO 8601."
        },
        "computedAgo": {
          "type": "string",
          "description": "The same instant in words, ready to show or say."
        },
        "approximate": {
          "type": "boolean",
          "description": "True when the count was sampled instead of counted exactly (very large\nor event-heavy segments), in which case it is rounded to three\nsignificant figures and `sampleFraction` and `marginPct` are present.\n"
        },
        "sampleFraction": {
          "type": "number",
          "format": "float",
          "description": "Fraction of the segment actually counted. Only when `approximate` is true."
        },
        "marginPct": {
          "type": "number",
          "format": "float",
          "description": "Margin of error of the sampled count, in per cent. Only when `approximate` is true."
        }
      },
      "required": [
        "count",
        "computedAt",
        "computedAgo",
        "approximate"
      ]
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/instasent-response-segment-item"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.