Skip to content
Docs
Select language:English

/api/v1/insights

GET
/api/v1/insights
curl --request GET \
  --url https://example.com/api/v1/insights

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
f.location
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
locations
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
money
required
boolean
vehicles
required
boolean
warranties
required
boolean
thisYear
required
integer
>= -9007199254740991 <= 9007199254740991
spending
required
object
years
required
Array<object>
object
year
required
integer
>= -9007199254740991 <= 9007199254740991
soFar
required
boolean
purchases
required
integer
>= -9007199254740991 <= 9007199254740991
unpriced
required
integer
>= -9007199254740991 <= 9007199254740991
byCurrency
required
Array<object>
object
currency
required
string
amount
required
string
hiddenIn
required
Array<string>
value
required
object
locations
required
Array<object>
object
locationId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
things
required
integer
>= -9007199254740991 <= 9007199254740991
valued
integer
>= -9007199254740991 <= 9007199254740991
byCurrency
Array<object>
object
currency
required
string
amount
required
string
moneyHidden
boolean
places
required
Array<object>
object
id
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
shortCode
required
string | null
name
required
string | null
unplaced
required
boolean
others
integer
>= -9007199254740991 <= 9007199254740991
things
required
integer
>= -9007199254740991 <= 9007199254740991
valued
integer
>= -9007199254740991 <= 9007199254740991
byCurrency
Array<object>
object
currency
required
string
amount
required
string
hiddenIn
required
Array<string>
vehicles
required
Any of:
object
thisMonth
required
string
months
required
Array<object>
object
month
required
string
byCurrency
required
Array<object>
object
currency
required
string
fuel
required
string
service
required
string
fees
required
string
total
required
string
items
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
shortCode
required
string | null
name
required
string | null
locationId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
ended
required
boolean
years
required
Array<object>
object
year
required
integer
>= -9007199254740991 <= 9007199254740991
soFar
required
boolean
fills
required
integer
>= -9007199254740991 <= 9007199254740991
services
required
integer
>= -9007199254740991 <= 9007199254740991
byCurrency
Array<object>
object
currency
required
string
fuel
required
string
service
required
string
fees
required
string
total
required
string
moneyHidden
boolean
more
required
integer
>= -9007199254740991 <= 9007199254740991
hiddenIn
required
Array<string>
warranties
required
Any of:
object
things
required
integer
>= -9007199254740991 <= 9007199254740991
covered
required
integer
>= -9007199254740991 <= 9007199254740991
expiring
required
integer
>= -9007199254740991 <= 9007199254740991
ended
required
integer
>= -9007199254740991 <= 9007199254740991
none
required
integer
>= -9007199254740991 <= 9007199254740991
expiringSoon
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
shortCode
required
string | null
name
required
string | null
locationId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
endsOn
required
string
repairs
required
Array<object>
object
year
required
integer
>= -9007199254740991 <= 9007199254740991
soFar
required
boolean
resolved
required
integer
>= -9007199254740991 <= 9007199254740991
byCurrency
Array<object>
object
currency
required
string
cost
required
string
covered
required
string
hiddenIn
required
Array<string>
Example
{
  "value": {
    "locations": [
      {
        "moneyHidden": true
      }
    ]
  },
  "vehicles": {
    "items": [
      {
        "moneyHidden": true
      }
    ]
  }
}