Get Automation by ID

Returns a specific automation by its ID

GET /automations/{id}

Get automation by ID

cURL

curl --request GET \
  --url https://app.drippi.ai/api/v1/automations/{id} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://app.drippi.ai/api/v1/automations/{id}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://app.drippi.ai/api/v1/automations/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.drippi.ai/api/v1/automations/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.drippi.ai/api/v1/automations/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.drippi.ai/api/v1/automations/{id}")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.drippi.ai/api/v1/automations/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "status": "success",
  "automation": {
    "id": "<string>",
    "sourceId": "<string>",
    "uid": "<string>",
    "name": "<string>",
    "automationType": "<string>",
    "status": "<string>",
    "testMode": true,
    "automationVersion": 123,
    "sendingAccount": "<string>",
    "startTime": {
      "_seconds": 123,
      "_nanoseconds": 123
    },
    "sentMessages": 123,
    "skippedMessages": 123,
    "respondedMessages": 123,
    "failedMessages": 123,
    "creditUsage": 123,
    "newMessagesActive": true,
    "followupsActive": true,
    "followups": {},
    "messageConfig": {
      "settings": {
        "tweetContext": {
          "mode": "<string>",
          "enabled": true
        },
        "websiteContext": {
          "mode": "<string>",
          "enabled": true
        },
        "splitMessages": true,
        "maxLength": 123
      },
      "temperature": 123,
      "context": "<string>",
      "model": "<string>",
      "generatorVersion": "<string>",
      "script": "<string>",
      "scriptText": "<string>",
      "messagePurpose": {},
      "messageElements": {},
      "messageTone": {},
      "backgroundInfo": {
        "jobTitle": "<string>",
        "name": "<string>",
        "productName": "<string>",
        "productDescription": "<string>",
        "productCategory": "<string>"
      }
    },
    "automationSettings": {
      "autoRetweet": {
        "enabled": true,
        "params": {}
      },
      "blacklistCheck": {
        "enabled": true,
        "params": {}
      },
      "activityCheck": {
        "enabled": true,
        "params": {
          "includeOnUnknown": true,
          "minDaysSinceLastActivity": 123
        }
      },
      "AICheck": {
        "enabled": true,
        "params": {
          "includeOnUnknown": true,
          "locationCheck": {
            "type": "<string>",
            "enabled": true,
            "params": {
              "countryCodes": [
                "<string>"
              ],
              "minGdpPerCapita": 123
            }
          },
          "languageCheck": {
            "type": "<string>",
            "enabled": true,
            "params": {
              "languageCodes": [
                "<string>"
              ]
            }
          }
        }
      },
      "previousConversationsCheck": {
        "enabled": true,
        "params": {}
      },
      "autoFollow": {
        "enabled": true,
        "params": {}
      },
      "autoLike": {
        "enabled": true,
        "params": {}
      },
      "previouslyContactedCheck": {
        "enabled": true,
        "params": {}
      }
    },
    "scheduleV1": {
      "scheduleType": "<string>",
      "timezone": {
        "name": "<string>",
        "id": "<string>"
      },
      "messages": "<string>",
      "timezoneModified": true,
      "hasAdvancedSchedule": true,
      "advancedSchedule": {}
    }
  }
}

{
  "status": "error",
  "message": "Something went wrong"
}

{
  "status": "error",
  "message": "Something went wrong"
}

{
  "status": "error",
  "message": "Something went wrong"
}

Returns a specific automation by its ID. Use this endpoint to retrieve detailed information about a particular automation campaign.

Authorizations

x-api-key · string · header · required

API key for authentication

Path Parameters

id · string · required

Automation ID

Response

200

application/json

Successfully retrieved automation

status · string

Example:

"success"

automation · object

Show child attributes