Loading ...

REST API: Update Event View Count | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Events » REST API: Update Event View Count
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 31

REST API: Update Event View Count

0 
 /5
0 (0votes)
Open API Guide
PUT/api/events/viewcount

Set an event's view count to a specific number. Site administrators only, unless the AllowAPICallToSetEventViewCount system property is on; to add one view, use Increase View Count instead. ResponseData is true.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.
Content-TypeYESapplication/jsonMust be set to application/json

Required Parameters

ParameterTypeRequiredLocationDescription
EventIDIntegerYESQueryUnique ID for a particular event
EventCountStringYESBodyThe number to set as the event's view count, sent as the bare JSON body (a number or a numeric string).

Example

Request Header

Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

Request URL

https://your-site.com/api/events/viewcount?EventID=222

Request Body

10

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": true
}

Error Response

{
  "Message": "The request is invalid."
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestEventID is missing or not an integer, or the body is missing.Send EventID in the query string and the count as the body.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenThe caller is not a site administrator and the AllowAPICallToSetEventViewCount system property is off (its default).Call as a site administrator, or have the property switched on.
500 Server ErrorThe body is not a whole number (long.Parse fails), or another internal failure.Send a whole number, then retry later.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages