← API Reference

planning API

Base URL: https://planning-api.ayoune.app — 12 entities

Example

cURL

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

TypeScript SDK

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

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

Entities

Entity	REST Path	SDK	Access	Right
BenchmarkCohortSnapshots	/benchmarkcohortsnapshots	ay.planning.benchmarkCohortSnapshots	read-only	planning.benchmarkcohortsnapshots	play_circle
BenchmarkOptIns	/benchmarkoptins	ay.planning.benchmarkOptIns	CRUD	planning.benchmarkoptins	play_circle
PlanningAlerts	/planningalerts	ay.planning.planningAlerts	CRUD	planning.planningalerts	play_circle
PlanningBlocks	/planningblocks	ay.planning.planningBlocks	CRUD	planning.planningblocks	play_circle
PlanningCells	/planningcells	ay.planning.planningCells	read-only	planning.planningcells	play_circle
PlanningDimensions	/planningdimensions	ay.planning.planningDimensions	CRUD	planning.planningdimensions	play_circle
PlanningModels	/planningmodels	ay.planning.planningModels	CRUD	planning.planningmodels	play_circle
PlanningScenarios	/planningscenarios	ay.planning.planningScenarios	CRUD	planning.planningscenarios	play_circle
PlanningSchedules	/planningschedules	ay.planning.planningSchedules	CRUD	planning.planningschedules	play_circle
PlanningSnapshotChunks	/planningsnapshotchunks	ay.planning.planningSnapshotChunks	read-only	planning.planningsnapshotchunks	play_circle
PlanningSnapshots	/planningsnapshots	ay.planning.planningSnapshots	read-only	planning.planningsnapshots	play_circle
PlanningTemplates	/planningtemplates	ay.planning.planningTemplates	CRUD	planning.planningtemplates	play_circle