CRM Analytics REST API jobs, schedules and history
What the CRM Analytics REST API can do and which resource and verb fit a task: starting and stopping dataflow and recipe jobs, syncing connections, schedule request bodies, and listing, labelling and restoring asset versions with the History API, within the API call limits.
Given a situation, demonstrate knowledge of what can be accomplished with the CRM Analytics API.
~7 min read · 13 practice questions ·
What the exam expects
- Recognise which tasks the CRM Analytics REST API supports (queries, datasets, dashboards, templates, XMD, dependencies, job nodes, runs and schedules) and which belong to Setup or user administration.
- Pick the resource and verb that start or stop a dataflow or recipe job, or run a data sync.
- Read a schedule request body and say when it runs, and know which assets accept an event-based schedule.
- Use the History API to list, label, preview and restore asset versions, and explain its retention and deletion limits.
- Diagnose failures caused by the API call limits.
Key terms: dataflow job (one run of a dataflow or recipe, started through /wave/dataflowjobs); targetDataflowId (the ID used to start a recipe as a dataflow job); assetId (the dataflow, recipe or data sync a schedule applies to); history record (a saved version of a dashboard, lens, recipe or dataflow); AnalyticsMaxHistories (org value that raises version retention).
Key facts
- Detail
- 10,000 calls per user per hour; 100 concurrent calls per org
- Detail
- POST /wave/dataflowjobs with its targetDataflowId as dataflowId
- Detail
- PATCH /wave/dataflowjobs/{dataflowjobId} with command stop
- Detail
- POST an empty body to /wave/dataConnectors/{connectorId}/ingest
- Detail
- PUT or DELETE /wave/asset/{assetId}/schedule
- Detail
- Dataflows and recipes only; not data syncs or Data Connections
- Detail
- 20 per asset: 10 tagged, 10 untagged; raise with AnalyticsMaxHistories
- Detail
- Deletes all its history; no undelete
- Detail
- Dataset XMD versions
- Detail
- Create, validate and update templates; access XMD
- When does listing a job's nodes return an empty collection?
- Why should a long-lived integration move off very old API versions?
- Which CLI command lists a dataflow's saved versions?
- What does a successful PUT to the schedule resource return?
The questions are free to read. Answers with their sources and self-grading are included with the pack.
Keep reading with the CRM Analytics and Einstein Discovery Consultant pack
- Core concepts
- Exam traps
- Worked scenario
The pack includes:
- All 26 lessons of the CRM Analytics and Einstein Discovery Consultant guide, with reading progress
- Interactive decision walks and step-by-step sequence steppers
- Practice exams purchase adds inline bank questions and topic practice (13 questions for this lesson)
- An official source cited for every claim
- An AI tutor that answers from the guide
- Choose guide-only, practice-only, or save $4 with both