Activity timeline, including which provider delivered each email

GET

/api/v1/workspaces/{workspace}/contacts/{contact}/activity

package main

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

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/contacts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/activity?filter=all&limit=8"

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

  req.Header.Add("Authorization", "Bearer <token>")

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

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

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/contacts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/activity?filter=all&limit=8';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/contacts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/activity?filter=all&limit=8' \
  --header 'Authorization: Bearer <token>'

Permission: subscribers:view

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

contact

required

string format: uuid

Query Parameters

filter

string

default: all

Allowed values: all deliveries engagement consent

cursor

string

<= 200 characters

limit

integer format: int64

default: 8 >= 1 <= 100

Responses

200

application/json

object

items

required

Array<object>

object

actor

string

afterDeliveryMin

integer format: int64

answer

string

answered

integer format: int64

required

string format: date-time

category

required

string

Allowed values: delivery engagement consent

client

string

code

Provider code: 250 2.6.0, 452 4.2.2

string

comment

string

consentLanguage

string

consentVersion

string

contactLanguageName

string

detail

string

diagnostic

string

editableUntil

string format: date-time

failover

required

boolean

required

string

imported

string

language

string

languageReason

string

Allowed values: "" match no_language not_offered missing draft held requested

linkLabel

string

list

string

machine

required

boolean

note

string

previous

string

provider

object

adapter

required

string

name

required

string

question

string

questions

integer format: int64

retriedDeliveredAt

string format: date-time

routeNote

string

source

string

sourceLabel

string

store

object

accepted

required

boolean

credited

string

currency

required

string

flow

string

items

required

Array<string>

name

required

string

order

string

platform

required

string

Allowed values: shopify woocommerce

total

required

integer format: int64

subject

required

string

type

required

Delivered, soft_bounce, open, click… or a consent action

string

url

string

variant

string

nextCursor

string

total

required

Events matching the filter

integer format: int64

Example

{
  "items": [
    {
      "category": "delivery",
      "languageReason": "",
      "store": {
        "platform": "shopify"
      }
    }
  ]
}

default

Error

application/problem+json

object

code

Stable error code, e.g. permission_denied

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object>

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

helpers

Members who hold the missing permission

Array<string>

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

meta

object

key

additional properties

permission

The missing permission key

string

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}