Skip to content
KynectLocal Docs

Get brand-wide revenue summary

GET
/v1/brands/{brandId}/revenue-settings
 
curl --request GET \
  --url https://kynectlocal-production.up.railway.app/v1/v1/brands/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/revenue-settings \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
brandId
required
string format: uuid

Brand identifier

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

Media type application/json
object
data
required
object
totals
required
object
formLeadsMtd
required
integer
estimatedRevenueCents
required
integer
locationCount
required
integer
configuredCount
required
integer
locations
required
Array<object>
object
locationId
required
string format: uuid
formLeadsMtd
required
integer
estimatedRevenueCents
required
integer
avgTicketCents
required
integer | null
closeRatePct
required
string | null
configured
required
boolean
Example generated
{
  "data": {
    "totals": {
      "formLeadsMtd": 1,
      "estimatedRevenueCents": 1,
      "locationCount": 1,
      "configuredCount": 1
    },
    "locations": [
      {
        "locationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "formLeadsMtd": 1,
        "estimatedRevenueCents": 1,
        "avgTicketCents": 1,
        "closeRatePct": "example",
        "configured": true
      }
    ]
  }
}

400

Section titled “400 ”

Validation error

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

401

Section titled “401 ”

Unauthenticated

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

403

Section titled “403 ”

Forbidden

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Section titled “404 ”

Not found

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

422

Section titled “422 ”

Unprocessable

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}