Spectora Public API

Agent Stats

Endpointhttps://connect.spectora.com

Retrieve agents for your company, enriched with inspection statistics. Each record represents a single agent (connection) with computed inspection counts, revenue totals, and inspection date ranges.

List agent stats

GET

https://connect.spectora.com

/v2/connection_stats

Returns a paginated list of agents for your company, enriched with inspection statistics. Each record represents a single agent (connection) and includes computed attributes such as inspection counts, revenue (quote totals), and inspection date ranges based on their role as buying or selling agent.

List agent stats › query Parameters

include

string

Comma-separated list of relationships to include in the response. Available relationships: agent_team.

page[number]

integer

Page number (starts at 1)

page[size]

integer

Number of records per page (default: 200, max: 200)

filter[id]

integer

Filter by agent ID (the connection ID for this agent in your company)

filter[agent_id]

integer

Filter by the agent's global ID (shared across companies)

filter[fulltext]

string

Full-text search across agent name, agency name, agent team name, and user details

filter[tag]

string[]

Filter by tag name(s). Can be a single tag or an array of tags.

filter[inspection_datetime_greater_than]

string · date-time

Only include inspections on or after this date when computing stats. ISO 8601 format (e.g., '2024-01-01T00:00:00Z').

filter[inspection_datetime_less_than]

string · date-time

Only include inspections before this date when computing stats. ISO 8601 format (e.g., '2024-12-31T23:59:59Z').

filter[first_inspection_date_greater_than]

string · date-time

Filter agents whose first inspection date is on or after this date. ISO 8601 format.

filter[first_inspection_date_less_than]

string · date-time

Filter agents whose first inspection date is before this date. ISO 8601 format.

filter[birthday_greater_than]

string · date

Filter agents with birthday on or after this date. Must be used together with birthday_less_than. Format: YYYY-MM-DD.

filter[birthday_less_than]

string · date

Filter agents with birthday before this date. Must be used together with birthday_greater_than. Format: YYYY-MM-DD.

filter[inspection_confirmed]

boolean

Filter by whether inspections are confirmed. When true, only confirmed inspections are included in stats.

filter[inspection_paid]

boolean

Filter by whether inspections are paid. When true, only paid inspections are included in stats.

filter[inactive_between][]

string[]

Find agents with no inspections in a date range. Requires exactly 2 dates (start and end) in ISO 8601 format. Example: filter[inactive_between][]=2024-01-01&filter[inactive_between][]=2024-06-01

sort

string

Sort field. Prefix with '-' for descending order. Available fields: first_name, last_name, phone, agency_name, birthday, buying_inspections_count, selling_inspections_count, total_inspections_count, buying_inspections_quote, selling_inspections_quote, total_inspections_quote, first_inspection_date, last_inspection_date

List agent stats › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List agent stats › Responses

Agent stats retrieved successfully

object[] · required

object

Pagination metadata

object

Pagination links

GET/v2/connection_stats

curl --request GET \
  --url https://connect.spectora.com/v2/connection_stats \
  --header 'Authorization: <string>'

shell

Example Responses

{
  "data": [
    {
      "id": "12345",
      "type": "connection_stat",
      "attributes": {
        "agent_id": 0,
        "first_name": "Jane",
        "last_name": "Smith",
        "email": "[email protected]",
        "phone": "phone",
        "agency_name": "agency_name",
        "agency_phone": "agency_phone",
        "agency_id": 0,
        "company_id": 0,
        "cc_email": "cc_email",
        "notes": "notes",
        "private_notes": "private_notes",
        "birthday": "2024-08-25",
        "image": "image",
        "buying_agent_inspections": 0,
        "selling_agent_inspections": 0,
        "buying_inspections_count": 0,
        "selling_inspections_count": 0,
        "total_inspections_count": 0,
        "buying_inspections_quote": 0,
        "selling_inspections_quote": 0,
        "total_inspections_quote": 0,
        "overall_inspections_count": 0,
        "first_inspection_date": "2024-08-25T15:00:00Z",
        "last_inspection_date": "2024-08-25T15:00:00Z",
        "tags": [
          {
            "id": 0,
            "company_id": 0,
            "name": "name",
            "color": "#5c9ccf",
            "created_at": "2024-08-25T15:00:00Z",
            "updated_at": "2024-08-25T15:00:00Z",
            "auto_tagging_rule": {},
            "auto_tagging_enabled": true,
            "auto_tagging_remove_on_fail": true,
            "auto_tagging_person": "auto_tagging_person"
          }
        ]
      },
      "relationships": {
        "agent_team": {
          "data": {
            "id": "id",
            "type": "agent_team"
          }
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "current": 1,
      "first": 1,
      "prev": 1,
      "next": 2,
      "last": 5,
      "records": 100
    }
  },
  "links": {
    "self": "/api/v2/connection_stats?page[number]=1&page[size]=20",
    "current": "/api/v2/connection_stats?page[number]=1&page[size]=20",
    "first": "/api/v2/connection_stats?page[number]=1&page[size]=20",
    "prev": "/api/v2/connection_stats?page[number]=1&page[size]=20",
    "next": "/api/v2/connection_stats?page[number]=2&page[size]=20",
    "last": "/api/v2/connection_stats?page[number]=5&page[size]=20",
    "records": "/api/v2/connection_stats?page[number]=1&page[size]=20"
  }
}

json

application/json

Agents Clients

List agent stats

GET

https://connect.spectora.com

/v2/connection_stats

List agent stats › query Parameters

include

string

Comma-separated list of relationships to include in the response. Available relationships: agent_team.

page[number]

integer

Page number (starts at 1)

page[size]

integer

Number of records per page (default: 200, max: 200)

filter[id]

integer

Filter by agent ID (the connection ID for this agent in your company)

filter[agent_id]

integer

Filter by the agent's global ID (shared across companies)

filter[fulltext]

string

Full-text search across agent name, agency name, agent team name, and user details

filter[tag]

string[]

Filter by tag name(s). Can be a single tag or an array of tags.

filter[inspection_datetime_greater_than]

string · date-time

Only include inspections on or after this date when computing stats. ISO 8601 format (e.g., '2024-01-01T00:00:00Z').

filter[inspection_datetime_less_than]

string · date-time

Only include inspections before this date when computing stats. ISO 8601 format (e.g., '2024-12-31T23:59:59Z').

filter[first_inspection_date_greater_than]

string · date-time

Filter agents whose first inspection date is on or after this date. ISO 8601 format.

filter[first_inspection_date_less_than]

string · date-time

Filter agents whose first inspection date is before this date. ISO 8601 format.

filter[birthday_greater_than]

string · date

Filter agents with birthday on or after this date. Must be used together with birthday_less_than. Format: YYYY-MM-DD.

filter[birthday_less_than]

string · date

Filter agents with birthday before this date. Must be used together with birthday_greater_than. Format: YYYY-MM-DD.

filter[inspection_confirmed]

boolean

Filter by whether inspections are confirmed. When true, only confirmed inspections are included in stats.

filter[inspection_paid]

boolean

Filter by whether inspections are paid. When true, only paid inspections are included in stats.

filter[inactive_between][]

string[]

Find agents with no inspections in a date range. Requires exactly 2 dates (start and end) in ISO 8601 format. Example: filter[inactive_between][]=2024-01-01&filter[inactive_between][]=2024-06-01

sort

string

List agent stats › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List agent stats › Responses

Agent stats retrieved successfully

object[] · required

object

Pagination metadata

object

Pagination links