Skip to content
GetsitecontrolDevelopers

Widget on/off history

GET
https://api.getsitecontrol.com/v1/sites/{site_id}/widgets/{widget_id}/history
curl --request GET \
  --url 'https://api.getsitecontrol.com/v1/sites/1/widgets/1/history?limit=50&order=oldest' \
  --header 'Authorization: Bearer <token>'

Every time the widget was turned on or off, oldest first; order=newest gives the latest first. Deleting or restoring an active widget, or suspending the account, is recorded as a switch with a reason.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
FieldDescription
site_id
required
Site Id
integer
widget_id
required
Widget Id
integer

Query Parameters

Section titled “Query Parameters”
FieldDescription
cursor
Cursor

next_cursor of the previous page, sent with the same order; omit for the first

string

next_cursor of the previous page, sent with the same order; omit for the first

limit
Limit

Items per page

integer
default: 50 >= 1 <= 100

Items per page

fields
Fields

Comma-separated fields to keep in each item, for example id,name; each item then carries only those fields and id. Omit for every field

string

Comma-separated fields to keep in each item, for example id,name; each item then carries only those fields and id. Omit for every field

order

Order of the items: oldest first (default) or newest first; asc and desc mean the same

string
Allowed values: oldest newest

Order of the items: oldest first (default) or newest first; asc and desc mean the same

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WidgetHistoryPage

One page of a list; next_cursor is null on the last page.

object
FieldDescription
items
required
Items
Array<object>
WidgetHistoryEntry
object
FieldDescription
id
required
Id
integer
occurred_at
required
Occurred At
string format: date-time
is_active
required
Is Active

The state the widget was put in

boolean
source
required
HistorySource

Who made a change. ui: the admin; api: an API key; mcp: an AI assistant; system: done automatically; support: GetSiteControl support.

string
Allowed values: ui api mcp system support
reason

Why, when the switch was a side effect: the widget was deleted, restored, or the account suspended

string
Allowed values: deleted restored account_suspended
api_key_id
Api Key Id

The key that made the switch, for source api

integer
nullable
author
Author

The user, Support, or id and name null for a user deleted since; null when no person made the switch

object
FieldDescription
id
Id

Null for Support or for a user who was deleted

integer
nullable
name
Name

Null when the user has no name

string
nullable
email
Email

The user’s sign-in e-mail; null for Support

string
nullable
next_cursor
Next Cursor
string
nullable

Example 

{
  "items": [
    {
      "source": "ui",
      "reason": "deleted"
    }
  ]
}

Headers

Section titled “Headers”
FieldDescription
GSC-Version
string

API version the response was produced for

X-Request-Id
string

Request id, echoed from the request when valid

X-RateLimit-Limit
integer

Limit of the tightest bucket

X-RateLimit-Remaining
integer

Requests left in its window

X-RateLimit-Reset
integer

End of its window, epoch seconds

400

Section titled “400”

Unsupported GSC-Version

Media typeapplication/problem+json
Problem

The documented shape of every error body on the versioned surface.

object
FieldDescription
type
required
Type
string
title
required
Title
string
status
required
Status
integer
detail
Detail
string
nullable
instance
required
Instance
string
reason
Reason
string
nullable
next
Next
string
nullable
request_id
required
Request Id
string
errors
Errors
Array<object>
nullable
ValidationIssue
object
FieldDescription
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
metadata
Metadata
object

Example · Generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "reason": "example",
  "next": "example",
  "request_id": "example",
  "errors": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ],
  "metadata": {}
}

Headers

Section titled “Headers”
FieldDescription
GSC-Version
string

API version the response was produced for

X-Request-Id
string

Request id, echoed from the request when valid

X-RateLimit-Limit
integer

Limit of the tightest bucket

X-RateLimit-Remaining
integer

Requests left in its window

X-RateLimit-Reset
integer

End of its window, epoch seconds

401

Section titled “401”

Missing or invalid API key or access token

Media typeapplication/problem+json
Problem

The documented shape of every error body on the versioned surface.

object
FieldDescription
type
required
Type
string
title
required
Title
string
status
required
Status
integer
detail
Detail
string
nullable
instance
required
Instance
string
reason
Reason
string
nullable
next
Next
string
nullable
request_id
required
Request Id
string
errors
Errors
Array<object>
nullable
ValidationIssue
object
FieldDescription
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
metadata
Metadata
object

Example · Generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "reason": "example",
  "next": "example",
  "request_id": "example",
  "errors": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ],
  "metadata": {}
}

Headers

Section titled “Headers”
FieldDescription
GSC-Version
string

API version the response was produced for

X-Request-Id
string

Request id, echoed from the request when valid

X-RateLimit-Limit
integer

Limit of the tightest bucket

X-RateLimit-Remaining
integer

Requests left in its window

X-RateLimit-Reset
integer

End of its window, epoch seconds

WWW-Authenticate
string

Authentication scheme: Bearer

403

Section titled “403”

Access denied

Media typeapplication/problem+json
Problem

The documented shape of every error body on the versioned surface.

object
FieldDescription
type
required
Type
string
title
required
Title
string
status
required
Status
integer
detail
Detail
string
nullable
instance
required
Instance
string
reason
Reason
string
nullable
next
Next
string
nullable
request_id
required
Request Id
string
errors
Errors
Array<object>
nullable
ValidationIssue
object
FieldDescription
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
metadata
Metadata
object

Example · Generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "reason": "example",
  "next": "example",
  "request_id": "example",
  "errors": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ],
  "metadata": {}
}

Headers

Section titled “Headers”
FieldDescription
GSC-Version
string

API version the response was produced for

X-Request-Id
string

Request id, echoed from the request when valid

X-RateLimit-Limit
integer

Limit of the tightest bucket

X-RateLimit-Remaining
integer

Requests left in its window

X-RateLimit-Reset
integer

End of its window, epoch seconds

404

Section titled “404”

Not found

Media typeapplication/problem+json
Problem

The documented shape of every error body on the versioned surface.

object
FieldDescription
type
required
Type
string
title
required
Title
string
status
required
Status
integer
detail
Detail
string
nullable
instance
required
Instance
string
reason
Reason
string
nullable
next
Next
string
nullable
request_id
required
Request Id
string
errors
Errors
Array<object>
nullable
ValidationIssue
object
FieldDescription
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
metadata
Metadata
object

Example · Generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "reason": "example",
  "next": "example",
  "request_id": "example",
  "errors": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ],
  "metadata": {}
}

Headers

Section titled “Headers”
FieldDescription
GSC-Version
string

API version the response was produced for

X-Request-Id
string

Request id, echoed from the request when valid

X-RateLimit-Limit
integer

Limit of the tightest bucket

X-RateLimit-Remaining
integer

Requests left in its window

X-RateLimit-Reset
integer

End of its window, epoch seconds

422

Section titled “422”

Validation failed

Media typeapplication/problem+json
Problem

The documented shape of every error body on the versioned surface.

object
FieldDescription
type
required
Type
string
title
required
Title
string
status
required
Status
integer
detail
Detail
string
nullable
instance
required
Instance
string
reason
Reason
string
nullable
next
Next
string
nullable
request_id
required
Request Id
string
errors
Errors
Array<object>
nullable
ValidationIssue
object
FieldDescription
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
metadata
Metadata
object

Example · Generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "reason": "example",
  "next": "example",
  "request_id": "example",
  "errors": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ],
  "metadata": {}
}

Headers

Section titled “Headers”
FieldDescription
GSC-Version
string

API version the response was produced for

X-Request-Id
string

Request id, echoed from the request when valid

X-RateLimit-Limit
integer

Limit of the tightest bucket

X-RateLimit-Remaining
integer

Requests left in its window

X-RateLimit-Reset
integer

End of its window, epoch seconds

429

Section titled “429”

Rate limited

Media typeapplication/problem+json
Problem

The documented shape of every error body on the versioned surface.

object
FieldDescription
type
required
Type
string
title
required
Title
string
status
required
Status
integer
detail
Detail
string
nullable
instance
required
Instance
string
reason
Reason
string
nullable
next
Next
string
nullable
request_id
required
Request Id
string
errors
Errors
Array<object>
nullable
ValidationIssue
object
FieldDescription
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
metadata
Metadata
object

Example · Generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "reason": "example",
  "next": "example",
  "request_id": "example",
  "errors": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ],
  "metadata": {}
}

Headers

Section titled “Headers”
FieldDescription
GSC-Version
string

API version the response was produced for

X-Request-Id
string

Request id, echoed from the request when valid

X-RateLimit-Limit
integer

Limit of the tightest bucket

X-RateLimit-Remaining
integer

Requests left in its window

X-RateLimit-Reset
integer

End of its window, epoch seconds

Retry-After
integer

Seconds until the bucket refills

503

Section titled “503”

Temporarily unavailable; retry later

Media typeapplication/problem+json
Problem

The documented shape of every error body on the versioned surface.

object
FieldDescription
type
required
Type
string
title
required
Title
string
status
required
Status
integer
detail
Detail
string
nullable
instance
required
Instance
string
reason
Reason
string
nullable
next
Next
string
nullable
request_id
required
Request Id
string
errors
Errors
Array<object>
nullable
ValidationIssue
object
FieldDescription
loc
required
Loc
Array
msg
required
Msg
string
type
required
Type
string
metadata
Metadata
object

Example · Generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "reason": "example",
  "next": "example",
  "request_id": "example",
  "errors": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ],
  "metadata": {}
}

Headers

Section titled “Headers”
FieldDescription
GSC-Version
string

API version the response was produced for

X-Request-Id
string

Request id, echoed from the request when valid

X-RateLimit-Limit
integer

Limit of the tightest bucket

X-RateLimit-Remaining
integer

Requests left in its window

X-RateLimit-Reset
integer

End of its window, epoch seconds

llms.txtOpenAPI