← API Reference

Monitoring API

Dashboards, KPIs, alerts, metrics, heartbeats

Base URL: https://monitoring-api.ayoune.app — 41 entities

Example

cURL

curl -H "Authorization: Bearer pat_your_token" \
  https://monitoring-api.ayoune.app/activeusers?limit=10

TypeScript SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

const result = await ay.monitoring.activeUsers.find().limit(10).exec();
console.log(result.payload());

Entities

Entity	REST Path	SDK	Access	Right
ActiveUsers	/activeusers	ay.monitoring.activeUsers	CRUD	monitoring.activeusers	play_circle
AdHijackerChecks	/adhijackerchecks	ay.monitoring.adHijackerChecks	read-only	monitoring.adhijackerchecks	play_circle
AdHijackers	/adhijackers	ay.monitoring.adHijackers	read-only	monitoring.adhijackers	play_circle
AdResults	/adresults	ay.monitoring.adResults	read-only	monitoring.adresults	play_circle
Ads	/ads	ay.monitoring.ads	read-only	monitoring.ads	play_circle
AdTypes	/adtypes	ay.monitoring.adTypes	CRUD	monitoring.adtypes	play_circle
AdvertisementAssets	/advertisementassets	ay.monitoring.advertisementAssets	CRUD	monitoring.advertisementassets	play_circle
AdvertiserWeeklyDomainKPIs	/advertiserweeklydomainkpis	ay.monitoring.advertiserWeeklyDomainKPIs	read-only	monitoring.advertiserweeklydomainkpis	play_circle
AdvertiserWeeklyDomainKPIsByIndustries	/advertiserweeklydomainkpisbyindustries	ay.monitoring.advertiserWeeklyDomainKPIsByIndustries	read-only	monitoring.advertiserweeklydomainkpisbyindustries	play_circle
BrandBidderChecks	/brandbidderchecks	ay.monitoring.brandBidderChecks	read-only	monitoring.brandbidderchecks	play_circle
BrandBidders	/brandbidders	ay.monitoring.brandBidders	read-only	monitoring.brandbidders	play_circle
CheckResults	/checkresults	ay.monitoring.checkResults	CRUD	monitoring.checkresults	play_circle
Checks	/checks	ay.monitoring.checks	CRUD	monitoring.checks	play_circle
Goals	/goals	ay.monitoring.goals	CRUD	monitoring.goals	play_circle
Incidents	/incidents	ay.monitoring.incidents	CRUD	monitoring.incidents	play_circle
IndustryKPIs	/industrykpis	ay.monitoring.industryKPIs	read-only	monitoring.industrykpis	play_circle
KeywordInterests	/keywordinterests	ay.monitoring.keywordInterests	read-only	monitoring.keywordinterests	play_circle
KeywordRelations	/keywordrelations	ay.monitoring.keywordRelations	CRUD	monitoring.keywordrelations	play_circle
KeywordResearches	/keywordresearches	ay.monitoring.keywordResearches	CRUD	monitoring.keywordresearches	play_circle
MarketAnalysisCases	/marketanalysiscases	ay.monitoring.marketAnalysisCases	CRUD	monitoring.marketanalysiscases	play_circle
MarketAnalysisResults	/marketanalysisresults	ay.monitoring.marketAnalysisResults	read-only	monitoring.marketanalysisresults	play_circle
MarketBudgets	/marketbudgets	ay.monitoring.marketBudgets	read-only	monitoring.marketbudgets	play_circle
MarketResearches	/marketresearches	ay.monitoring.marketResearches	read-only	monitoring.marketresearches	play_circle
MarketResearchKeywordSets	/marketresearchkeywordsets	ay.monitoring.marketResearchKeywordSets	CRUD	monitoring.marketresearchkeywordsets	play_circle
Markets	/markets	ay.monitoring.markets	read-only	monitoring.markets	play_circle
OrganicResults	/organicresults	ay.monitoring.organicResults	read-only	monitoring.organicresults	play_circle
Organics	/organics	ay.monitoring.organics	read-only	monitoring.organics	play_circle
PageStats	/pagestats	ay.monitoring.pageStats	read-only	monitoring.pagestats	play_circle
ProductListingAds	/productlistingads	ay.monitoring.productListingAds	read-only	monitoring.productlistingads	play_circle
ProductListingAdsResults	/productlistingadsresults	ay.monitoring.productListingAdsResults	read-only	monitoring.productlistingadsresults	play_circle
ResearchBudgets	/researchbudgets	ay.monitoring.researchBudgets	read-only	monitoring.researchbudgets	play_circle
SearchKeywords	/searchkeywords	ay.monitoring.searchKeywords	CRUD	monitoring.searchkeywords	play_circle
SearchResults	/searchresults	ay.monitoring.searchResults	CRUD	monitoring.searchresults	play_circle
SearchRuns	/searchruns	ay.monitoring.searchRuns	CRUD	monitoring.searchruns	play_circle
SerpHtmlArchives	/serphtmlarchives	ay.monitoring.serpHtmlArchives	CRUD	monitoring.serphtmlarchives	play_circle
SERPHtmls	/serphtmls	ay.monitoring.sERPHtmls	CRUD	monitoring.serphtmls	play_circle
Serps	/serps	ay.monitoring.serps	CRUD	monitoring.serps	play_circle
Sessions	/sessions	ay.monitoring.sessions	CRUD	monitoring.sessions	play_circle
StatusComponents	/statuscomponents	ay.monitoring.statusComponents	CRUD	monitoring.statuscomponents	play_circle
StatusSubscriptions	/statussubscriptions	ay.monitoring.statusSubscriptions	CRUD	monitoring.statussubscriptions	play_circle
Views	/views	ay.monitoring.views	read-only	monitoring.views	play_circle