Shorted
POST/shorts.v1alpha1.PoliticiansService/GetPoliticianAnalytics

Aggregate shape of the register: which parties declare interests in which industries, and where members are from.

COUNTS OF PEOPLE AND DECLARATIONS ONLY. There is no weight, size, exposure or value here and none may be added — the registers do not record any, so any such figure would be invented. A cell says "N members of this party declared an interest in a company in this industry", and nothing more.

Parameters

Connect-Protocol-VersionheaderRequired
number [1]

Define the version of the Connect protocol

Connect-Timeout-Msheader
number

Define the timeout, in ms

Request Body

application/json
object
currentOnlyboolean

Restrict to interests declared as current, rather than every interest ever declared across parliaments 44-48. (proto bool)

topIndustriesinteger <int32>

Cap the industry axis to the N most-declared, so the heatmap stays readable. The remainder is NOT silently dropped — the response reports what was cut. (proto int32)

Responses

200Success
application/json
object
asAtstring <date-time>

(proto google.protobuf.Timestamp)

cellsarray

(proto shorts.v1alpha1.PartyIndustryCell)

Array Items:
industriesarray

The axes, pre-ordered, so the client does not re-derive an ordering and silently disagree with the server about which industries were included. (proto shorts.v1alpha1.IndustryTotal)

Array Items:
industriesOmittedinteger <int32>

Industries excluded by top_industries, stated rather than dropped silently. (proto int32)

partiesarray

(proto shorts.v1alpha1.PartyTotal)

Array Items:
sourceLicencestring

(proto string)

statesarray

(proto shorts.v1alpha1.StateTotal)

Array Items:
defaultError
application/json
object

Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation

codestring [canceled, unknown, invalid_argument, deadline_exceeded, not_found, already_exists, permission_denied, resource_exhausted, failed_precondition, aborted, out_of_range, unimplemented, internal, unavailable, data_loss, unauthenticated]

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

detailsarray

A list of messages that carry the error details. There is no limit on the number of messages.

Array Items:
messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

curl -X POST "https://api.shorted.com.au/shorts.v1alpha1.PoliticiansService/GetPoliticianAnalytics" \
  -H "Content-Type: application/json" \
  -d '{
  "currentOnly": true,
  "topIndustries": 0
}'