API : Tools: Changelog

Introduction

This API returns a log of what has changed on a customer or on a resellers customers, since a specific cutoff-time.

The log holds the last 5 days of changes, if the feature flag CHANGELOG is enabled on the customer.

Request

URL	https://api.telecomx.dk/tools/changelog
Method	GET
Access level	VIEWER, MANAGER, OWNER, RESELLER, RESELLER_ADMIN, ADMIN
query	since	Date	`[optional]` Date and time that the events in the change log must be newer than. If not specified all events are returned.
	customer	Id	`[optional]` Id of the customer to return events for (defaults to users own customer if customer and reseller is not specified), or…
	reseller	Id	`[optional]` Id of reseller, whose customers to return events for.
	remove	Boolean	`[optional]` True to remove the items from the change log that was returned.

Query example

https://api.telecomx.dk/tools/changelog?since=2025-01-01T00:00:00.000Z&reseller=12345678901234567890ABCD
https://api.telecomx.dk/tools/changelog?reseller=12345678901234567890ABCD&remove=true
https://api.telecomx.dk/tools/changelog?customer=12345678901234567890ABCE&remove=true

Response

Field	Type	Description
_id	Id	Unique id of event.
customer	Id	Id of customer it happened on.
reseller	Id	Id of the reseller the customer belongs to.
when	Date	Date and time it happened.
where	String	Name of the section (collection) it happened in.
what	String	Type of event: CREATE, UPDATE, DELETE, OTHER.
id	Id	Id of the item that was changed.

Response example

{
  _id: ObjectId('1234567890ABCDEF12345678'),
  customer: ObjectId('1234567890ABCDEF12345678'),
  reseller: ObjectId('1234567890ABCDEF12345670'),
  when: ISODate('2025-01-01T00:00:00.000Z'),
  where: 'Customers',
  what: 'UPDATE',
  id: ObjectId('12345678901234567890AAAA')
}

Errors

Error code	Message	Description
403	access_denied	Access denied
404	customer	Customer not found
404	reseller	Reseller not found
500	internal_error	<Unspecified>

WIKI

Table of Contents