Response Format & Schema

All endpoints across SOCIOAPI return standardized, predictable JSON envelopes containing status metadata, execution metrics, real-time credit consumption tracking, and structured payloads.

Envelope Schema Fields

Field Name	Type	Description
success	boolean	Indicates whether the request was successfully processed (`true`) or encountered an error (`false`).
status_code	integer	Standard HTTP status code matching the response header (e.g., 200, 201, 400, 401, 403, 429).
message	string	Human-readable status or operational message regarding the request outcome.
time	object	Execution benchmarking metrics detailing backend processing duration (e.g., `15.845 ms`).
meta_info	object	Contextual metadata containing subscription billing info (`plan_type`, `remaining_credits`, `credits_charged`) and client IP audit logs.
data	object \| array \| null	The primary extracted resource array or object payload. Set to `null` on failure responses.
pagination	object (optional)	Present on paginated endpoints. Contains `total_items`, `total_pages`, `current_page`, and `page_size`.

Standard JSON Response Samples

Select an HTTP status code below to preview its full JSON response payload structure:

200 OK Envelope

Successful GET data retrieval response with pagination.

{
  "success": true,
  "status_code": 200,
  "message": "Success Retrieve Data..",
  "time": {
    "value": "15.845 ms",
    "setTimeBeforeActions": true
  },
  "meta_info": {
    "billing": {
      "plan_type": "CREDIT",
      "plan_name": "Starter",
      "remaining_credits": 10,
      "credits_charged": 5
    },
    "log": {
      "ip": "114.124.211.178"
    }
  },
  "data": [
    {
      "post_id": "3886838303705289135",
      "platform": "instagram",
      "caption": "Contoh konten postingan...",
      "engagement": 85
    }
  ],
  "pagination": {
    "total_items": 120,
    "total_pages": 12,
    "current_page": 1,
    "page_size": 10
  }
}