{ "opencollection": "1.0.0", "info": { "name": "Amperity API (Unstable)", "version": "unstable" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Audit Events", "type": "folder" }, "items": [ { "info": { "name": "GET /audit-events", "type": "http" }, "http": { "method": "GET", "url": "https://app.amperity.com/api/audit-events", "headers": [ { "name": "api-version", "value": "" }, { "name": "amperity-tenant", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records to include in a single page of results." }, { "name": "next_token", "value": "", "type": "query", "description": "An opaque token that is used to paginate results. Omit the `next_token` property\nto return the first page. Use the cursor value for `next_token` that was returned\nin a response to view the next page of results.\n\nFor example: `ABCd1fghIJk2l3M`\n\n> **Note:** The possible values for `next_token` are returned within the 200 response.\n\n> **Important:** The value for `next_token` cannot be null.\n" }, { "name": "with_total", "value": "", "type": "query", "description": "Set this value to `true` to include a total count of all results. Default value: `false`.\n\n> **Note:** Obtaining the total count of all results can be an expensive operation when there is a high number of pages in the results set.\n" }, { "name": "happened_from", "value": "", "type": "query", "description": "The start date (inclusive) that defines the beginning of the time range for which audit\nevents are returned. For example: \"2026-04-01T11:11:11Z\".\n\nThe start date must be a string, should be in ISO-8601 format, and should be in UTC.\n" }, { "name": "happened_to", "value": "", "type": "query", "description": "The end date (exclusive) that defines the end of the time range for which audit events\nare returned. For example: \"2026-03-01T11:11:11Z\".\n\nThe values for the end date must be a string, should be in ISO-8601 format, and should be in UTC.\n" } ] }, "docs": "Amperity maintains records of user activity that occured in your tenant. For example:\n\n- A user makes a configuration change to the Amperity platform\n- A user creates a sandbox\n- A user views personally identifiable information (PII)\n- A workflow was stopped by a user\n- A user configured a destination\n- A user created an API key\n- A user was assigned to a resource group\n\nUse the **GET /audit-events** endpoint to return a log of user activity that occurred with\nyour tenant. Each response may cont" } ] }, { "info": { "name": "Campaigns", "type": "folder" }, "items": [ { "info": { "name": "GET /campaign-drafts", "type": "http" }, "http": { "method": "GET", "url": "https://app.amperity.com/api/campaign-drafts", "headers": [ { "name": "api-version", "value": "" }, { "name": "amperity-tenant", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records to include in a single page of results." }, { "name": "next_token", "value": "", "type": "query", "description": "An opaque token that is used to paginate results. Omit the `next_token` property\nto return the first page. Use the cursor value for `next_token` that was returned\nin a response to view the next page of results.\n\nFor example: `ABCd1fghIJk2l3M`\n\n> **Note:** The possible values for `next_token` are returned within the 200 response.\n\n> **Important:** The value for `next_token` cannot be null.\n" }, { "name": "with_total", "value": "", "type": "query", "description": "Set this value to `true` to include a total count of all results. Default value: `false`.\n\n> **Note:** Obtaining the total count of all results can be an expensive operation when there is a high number of pages in the results set.\n" }, { "name": "destination_data_template_id", "value": "", "type": "query", "description": "Use this parameter to restrict the list of campaign drafts that are returned to only\ncampaign drafts that are configured to use a specific data template.\n\n> **Tip:** You can find the ID for the data template from the Amperity user interface. From the Destinations page, open the menu in the same row as the data template for which the ID is to be copied, and then select Copy ID.\n" } ] }, "docs": "Use the **GET /campaign-drafts** endpoint to return a list of draft campaigns from your\ntenant. You may restrict the list of draft campaigns to those associated with a specific\ndata template.\n\n> **Note:** This endpoint is only available from the **unstable** version of the Amperity\n> API and may change without notice.\n" }, { "info": { "name": "GET /campaigns", "type": "http" }, "http": { "method": "GET", "url": "https://app.amperity.com/api/campaigns", "headers": [ { "name": "api-version", "value": "" }, { "name": "amperity-tenant", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records to include in a single page of results." }, { "name": "next_token", "value": "", "type": "query", "description": "An opaque token that is used to paginate results. Omit the `next_token` property\nto return the first page. Use the cursor value for `next_token` that was returned\nin a response to view the next page of results.\n\nFor example: `ABCd1fghIJk2l3M`\n\n> **Note:** The possible values for `next_token` are returned within the 200 response.\n\n> **Important:** The value for `next_token` cannot be null.\n" }, { "name": "with_total", "value": "", "type": "query", "description": "Set this value to `true` to include a total count of all results. Default value: `false`.\n\n> **Note:** Obtaining the total count of all results can be an expensive operation when there is a high number of pages in the results set.\n" }, { "name": "destination_data_template_id", "value": "", "type": "query", "description": "Use this parameter to restrict the list of campaigns that are returned to only\ncampaigns that are configured to use a specific data template.\n\n> **Tip:** You can find the ID for the data template from the Amperity user interface. From the Destinations page, open the menu in the same row as the data template for which the ID is to be copied, and then select Copy ID.\n" } ] }, "docs": "Use the **GET /campaigns** endpoint to return a list of campaigns from your tenant. You may\nrestrict the list of campaigns to those associated with a specific data template.\n" } ] }, { "info": { "name": "Segments", "type": "folder" }, "items": [ { "info": { "name": "GET /segments", "type": "http" }, "http": { "method": "GET", "url": "https://app.amperity.com/api/segments", "headers": [ { "name": "api-version", "value": "" }, { "name": "amperity-tenant", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records to include in a single page of results." }, { "name": "next_token", "value": "", "type": "query", "description": "An opaque token that is used to paginate results. Omit the `next_token` property\nto return the first page. Use the cursor value for `next_token` that was returned\nin a response to view the next page of results.\n\nFor example: `ABCd1fghIJk2l3M`\n\n> **Note:** The possible values for `next_token` are returned within the 200 response.\n\n> **Important:** The value for `next_token` cannot be null.\n" }, { "name": "with_total", "value": "", "type": "query", "description": "Set this value to `true` to include a total count of all results. Default value: `false`.\n\n> **Note:** Obtaining the total count of all results can be an expensive operation when there is a high number of pages in the results set.\n" } ] }, "docs": "Use the **GET /segments** endpoint to return a list of segments from your tenant.\n" } ] }, { "info": { "name": "Ingest", "type": "folder" }, "items": [ { "info": { "name": "GET /ingest/jobs", "type": "http" }, "http": { "method": "GET", "url": "https://app.amperity.com/api/ingest/jobs", "headers": [ { "name": "api-version", "value": "" }, { "name": "amperity-tenant", "value": "" } ], "params": [ { "name": "with_total", "value": "", "type": "query", "description": "Set this value to `true` to include a total count of all results. Default value: `false`.\n\n> **Note:** Obtaining the total count of all results can be an expensive operation when there is a high number of pages in the results set.\n" }, { "name": "created_from", "value": "", "type": "query", "description": "A timestamp that defines the start (inclusive) of a 7-day time window in which one or\nmore ingest jobs started. See the **created_to** request parameter.\n\nThis timestamp may be a partial timestamp, such as YYYY-MM-DD. The timestamp must be in ISO-8601 format and is in Coordinated Universal Time (UTC).\n\n> **Important:** Only ingest jobs that have a **started_at** value that falls within this time window is returned. See the **created_at** response property for the GET /ingest/jobs/{id} endpoint.\n" }, { "name": "created_to", "value": "", "type": "query", "description": "A timestamp that defines the end (exclusive) of a 7-day time window in which one or\nmore ingest jobs started. See the **created_from** request parameter.\n\nThis timestamp may be a partial timestamp, such as YYYY-MM-DD. The timestamp must be in ISO-8601 format and is in Coordinated Universal Time (UTC).\n\n> **Important:** Only ingest jobs that have a **started_at** value that falls within this time window is returned. See the **created_at** response property for the GET /ingest/jobs/{id} endpoint.\n" } ] }, "docs": "Use the **GET /ingest/jobs** endpoint to return a list of jobs from your tenant that\noccurred within the previous 7 days.\n" }, { "info": { "name": "GET /ingest/jobs/{job-id}", "type": "http" }, "http": { "method": "GET", "url": "https://app.amperity.com/api/ingest/jobs/:job-id", "headers": [ { "name": "api-version", "value": "" }, { "name": "amperity-tenant", "value": "" } ], "params": [ { "name": "job-id", "value": "", "type": "path", "description": "The Amperity internal identifier for the ingest job. For example: `isj-20240701-48815-6dcXdk`. From the workflows page, on the right side, click Recent Activity, select Ingest details under the job, and copy the job id from the open dialog box.\n" } ] }, "docs": "Use the **GET /ingest/jobs/{id}** endpoint to return details for a specific ingest job,\nincluding a summary of the records, files, and feeds that were ingested.\n" } ] }, { "info": { "name": "Workflow", "type": "folder" }, "items": [ { "info": { "name": "GET /workflow/runs", "type": "http" }, "http": { "method": "GET", "url": "https://app.amperity.com/api/workflow/runs", "headers": [ { "name": "api-version", "value": "" }, { "name": "amperity-tenant", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of records to include in a single page of results." }, { "name": "next_token", "value": "", "type": "query", "description": "An opaque token that is used to paginate results. Omit the `next_token` property\nto return the first page. Use the cursor value for `next_token` that was returned\nin a response to view the next page of results.\n\nFor example: `ABCd1fghIJk2l3M`\n\n> **Note:** The possible values for `next_token` are returned within the 200 response.\n\n> **Important:** The value for `next_token` cannot be null.\n" }, { "name": "with_total", "value": "", "type": "query", "description": "Set this value to `true` to include a total count of all results. Default value: `false`.\n\n> **Note:** Obtaining the total count of all results can be an expensive operation when there is a high number of pages in the results set.\n" }, { "name": "created_from", "value": "", "type": "query", "description": "A timestamp that defines the start (inclusive) of the time window in which one or more\nworkflows started to run. See the **created_to** request parameter.\n\nThis timestamp may be a partial timestamp, such as YYYY-MM-DD. The timestamp must be in ISO-8601 format and is in Coordinated Universal Time (UTC).\n\n> **Important:** Only workflows that have a **created_at** value that falls within this time window is returned. See the **created_at** response property for the GET /workflow/runs/{id} endpoint.\n" }, { "name": "created_to", "value": "", "type": "query", "description": "A timestamp that defines the end (exclusive) of the time window in which one or more\nworkflows started to run. See the **created_from** request parameter.\n\nThis timestamp may be a partial timestamp, such as YYYY-MM-DD. The timestamp must be in ISO-8601 format and is in Coordinated Universal Time (UTC).\n\n> **Important:** Only workflows that have a **created_at** value that falls within this time window is returned. See the **created_at** response property for the GET /workflow/runs/{id} endpoint.\n" }, { "name": "ended_from", "value": "", "type": "query", "description": "A timestamp that defines the start (inclusive) of the time window in which one or more\nworkflows stopped running. See the **ended_to** request parameter.\n\nThis timestamp may be a partial timestamp, such as YYYY-MM-DD. The timestamp must be in ISO-8601 format and is in Coordinated Universal Time (UTC).\n\n> **Important:** Only workflows that have an **ended_at** value that falls within this time window is returned. See the **ended_at** response property for the GET /workflow/runs/{id} endpoint.\n" }, { "name": "ended_to", "value": "", "type": "query", "description": "A timestamp that defines the end (exclusive) of the time window in which one or more\nworkflows stopped running. See the **ended_from** request parameter.\n\nThis timestamp may be a partial timestamp, such as YYYY-MM-DD. The timestamp must be in ISO-8601 format and is in Coordinated Universal Time (UTC).\n\n> **Important:** Only workflows that have an **ended_at** value that falls within this time window is returned. See the **ended_at** response property for the GET /workflow/runs/{id} endpoint.\n" }, { "name": "state", "value": "", "type": "query", "description": "Return a list of workflows that only match the specified workflow state. May be one of the following:\n\n- Started\n- In progress\n- Stopping\n- Stopped\n- Succeeded\n\n> **Note:** This is the same value that is visible from the Status column on each individual workflow page.\n" }, { "name": "type", "value": "", "type": "query", "description": "Return a list of workflows that only match the specified workflow type.\n\n> **Tip:** Use this endpoint to return a list of workflows and workflow types, and then use a value from the `type` response parameter to make a new request that filters by that workflow type value.\n" } ] }, "docs": "Use the **GET /workflow/runs** endpoint to return a list of workflows that exist within\nthe date range defined in the request.\n" }, { "info": { "name": "POST /workflow/runs", "type": "http" }, "http": { "method": "POST", "url": "https://app.amperity.com/api/workflow/runs", "headers": [ { "name": "api-version", "value": "" }, { "name": "amperity-tenant", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Use the **POST /workflow/runs** endpoint to start a workflow. Supports running courier\ngroups, orchestration groups, and campaigns.\n" }, { "info": { "name": "GET /workflow/runs/{workflow-id}", "type": "http" }, "http": { "method": "GET", "url": "https://app.amperity.com/api/workflow/runs/:workflow-id", "headers": [ { "name": "api-version", "value": "" }, { "name": "amperity-tenant", "value": "" } ], "params": [ { "name": "workflow-id", "value": "", "type": "path", "description": "The unique identifier for a workflow, similar to: `wf-20240603-12345-MNabc`. The workflow ID must be in the URL. For example: /workflow/runs/wf-20240603-12345-MNabc. Use the GET /workflow/runs endpoint to get a list of workflow IDs or copy the ID from the Workflows page in Amperity.\n" }, { "name": "view", "value": "", "type": "query", "description": "Set this value to overview to return only the following parameters: created_at, ended_at, id, name, state, tenant, and type. Set this value to verbose to return all response parameters for the workflow, including for any tasks that were started by the workflow. Default value: overview.\n" } ] }, "docs": "Use the **GET /workflow/runs/{id}** endpoint to return details for a specific workflow.\n" }, { "info": { "name": "POST /workflow/runs/{workflow-id}/stop", "type": "http" }, "http": { "method": "POST", "url": "https://app.amperity.com/api/workflow/runs/:workflow-id/stop", "headers": [ { "name": "api-version", "value": "" }, { "name": "amperity-tenant", "value": "" } ], "params": [ { "name": "workflow-id", "value": "", "type": "path", "description": "The Amperity internal identifier for the workflow. For example: `wf-20240619-14418-6UhqSe`. On the workflows page, under Actions, copy the workflow id from the dropdown.\n" } ] }, "docs": "Use the **POST /workflow/runs/{id}/stop** endpoint to stop a running workflow.\n" } ] } ], "bundled": true }