Endpoints

The Amperity API enables programmatic access to your Amperity tenant with the following groups of endpoints:

Audit events

Use the audit event endpoints to return a log of up to 1000 audit events for user activity.

GET /audit-events

Amperity maintains records of user activity that occured in your tenant. For example:

  • A user makes a configuration change to the Amperity platform

  • A user creates a sandbox

  • A user views personally identifiable information (PII)

  • A workflow was stopped by a user

  • A user configured a destination

  • A user created an API key

  • A user was assigned to a resource group

endpoint_get_audit_events_list.html

Campaigns

Use campaign endpoints to return a list of campaigns or draft campaigns.

GET /campaign-drafts

Use the GET /campaign-drafts endpoint to return a list of draft campaigns from your tenant. You may restrict the list of draft campaigns to those associated with a specific data template.

endpoint_get_campaign_drafts_list.html
GET /campaigns

Use the GET /campaigns endpoint to return a list of campaigns from your tenant. You may restrict the list of campaigns to those associated with a specific data template.

endpoint_get_campaigns_list.html

Ingest jobs

Use ingest job endpoints to return a list of jobs or return details about a specific job.

GET /ingest/jobs

Use the GET /ingest/jobs endpoint to return a list of jobs from your tenant that occurred within the previous 7 days.

endpoint_get_ingest_jobs.html
GET /ingest/jobs/(id)

Use the GET /ingest/jobs/{id} endpoint to return a list of jobs from your tenant.

endpoint_get_ingest_jobs_id.html

Segments

Use the segments endpoint to return a list of segments.

GET /segments

Use the GET /segments endpoint to return a list of segments from your tenant.

endpoint_get_segments_list.html

Workflows

Use workflows endpoints to get a list of workflows, details for a specific workflow, start and stop a workflow.

GET /workflow/runs

Use the GET /workflow/runs endpoint to return a list of workflows that exist within the date range defined in the request.

endpoint_get_workflows_list.html
GET /workflow/runs/{id}

Use the GET /workflow/runs/{id} endpoint to return details for a specific workflow.

endpoint_get_workflows_fetch.html
POST /workflow/runs

Use the POST /workflow/runs/ endpoint to start a workflow.

endpoint_post_workflows_start.html
POST /workflow/runs/{id}/stop

Use the POST workflow/runs/{id}/stop to stop a running workflow.

endpoint_post_workflows_stop.html