Skip to content
ReputeCastReputeCast Docs

A store's page: numbers, sync, consent, attribution, webhooks and activity

GET
/api/v1/workspaces/{workspace}/stores/{id}
curl --request GET \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/stores/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Permission: integrations:view

Credentials are write-only: only hints are returned.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace
required

Workspace slug

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

Workspace slug

id
required

The store’s id

string format: uuid

The store’s id

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
activity
required
Array<object>
object
accepted
required
boolean
amount
required
integer format: int64
at
required
string format: date-time
by
string
contact
required
boolean
contactId
string
credited
string
creditedKind
string
Allowed values: campaign automation ""
creditedStep
integer format: int64
currency
string
customer
string
flow
string
flows
required
Array<string>
hours
integer format: int64
id
required
string
kind
required
string
Allowed values: order refund checkout_abandoned checkout_not_emailed reconciliation webhook_missing webhook_registered customer_unsubscribed unsubscribe_passed import_started import_finished connected reconnected disconnected revoked rate_limited sync_error
lists
required
Array<string>
matched
string
Allowed values: click_token email none ""
message
string
missed
required
integer format: int64
order
string
polled
required
boolean
products
required
integer format: int64
reason
string
recovered
required
boolean
source
string
tone
required
string
Allowed values: neutral ok info warn bad
topic
string
until
string format: date-time
window
integer format: int64
apiVersion
required
string
appName
required
string
attribution
required
object
byEmail
required
integer format: int64
byToken
required
integer format: int64
credited
required
integer format: int64
creditedRevenue
required
integer format: int64
days
required
integer format: int64
orders
required
integer format: int64
others
object
count
required
integer format: int64
id
string
kind
required
string
Allowed values: campaign automation others
name
required
string
orders
required
integer format: int64
revenue
required
integer format: int64
param
required
string
revenue
required
integer format: int64
rows
required
Array<object>
object
count
required
integer format: int64
id
string
kind
required
string
Allowed values: campaign automation others
name
required
string
orders
required
integer format: int64
revenue
required
integer format: int64
setAt
string format: date-time
setBy
string
tagExample
required
string
tagHost
required
string
tagLinks
required
boolean
canManage
required
boolean
capabilities
required
Array<string>
connectedAt
string format: date-time
connectedBy
required
string
consent
required
object
listCreated
required
boolean
listId
string
listMembers
required
integer format: int64
listName
string
writeBack
required
boolean
writeBackSupported
required
boolean
writeGranted
required
boolean
flows
required
Array<object>
object
id
required
string
kind
required
string
name
required
string
pauseReason
string
status
required
string
helpers
required
Array<string>
lists
required
Array<object>
object
id
required
string
members
required
integer format: int64
name
required
string
store
required
boolean
numbers
required
object
credited
required
integer format: int64
creditedRevenue
required
integer format: int64
currency
required
string
days
required
integer format: int64
listMembers
required
integer format: int64
orders
required
integer format: int64
revenue
required
integer format: int64
share
required
number format: double
plugin
object
checkedAt
string format: date-time
checkouts
required
boolean
consent
required
boolean
found
required
boolean
host
required
string
siteId
string
skipped
required
boolean
version
string
publicDomain
required
string
recovered
required
object
orders
required
integer format: int64
revenue
required
integer format: int64
since
string format: date-time
store
required
object
address
required
string
currency
required
string
demo
required
boolean
domain
required
string
id
required
string
listId
string
listName
string
name
required
string
platform
required
string
Allowed values: shopify woocommerce
products
required
integer format: int64
status
required
string
Allowed values: connecting importing connected disconnected
step
required
string
sync
required
object
disconnectedAt
string format: date-time
disconnectedBy
string
import
object
accepted
required
integer format: int64
collections
required
integer format: int64
customers
required
object
done
required
integer format: int64
total
required
integer format: int64
customersSkipped
required
boolean
finishedAt
string format: date-time
known
required
integer format: int64
matching
required
object
done
required
integer format: int64
total
required
integer format: int64
minutesLeft
required
integer format: int64
months
required
integer format: int64
notAdded
required
integer format: int64
orders
required
object
done
required
integer format: int64
total
required
integer format: int64
phase
required
string
Allowed values: products customers orders matching done
products
required
object
done
required
integer format: int64
total
required
integer format: int64
startedAt
required
string format: date-time
startedBy
required
string
lastEventAt
string format: date-time
missing
required
Array<string>
missingSince
string format: date-time
rateLimitedUntil
string format: date-time
revokedAt
string format: date-time
revokedReason
required
string
Allowed values: "" uninstalled revoked
state
required
string
Allowed values: connecting importing connected webhook_missing rate_limited no_plugin disconnected
sync
required
object
accepted
required
integer format: int64
collections
required
Array<string>
customersFromOrders
required
boolean
importFinished
string format: date-time
importMinutes
required
integer format: int64
known
required
integer format: int64
missed
required
integer format: int64
months
required
integer format: int64
new
required
integer format: int64
notAdded
required
integer format: int64
ordersImported
required
integer format: int64
products
required
integer format: int64
reconciledAt
string format: date-time
webhooks
required
integer format: int64
webhooksTotal
required
integer format: int64
usedBy
required
Array<object>
object
id
string
kind
required
string
Allowed values: automation campaign reports
name
string
status
string
webhooks
required
Array<object>
object
error
string
lastEventAt
string format: date-time
missingSince
string format: date-time
status
required
string
Allowed values: pending registered missing failed
topic
required
string

Example 

{
  "activity": [
    {
      "creditedKind": "campaign",
      "kind": "order",
      "matched": "click_token",
      "tone": "neutral"
    }
  ],
  "attribution": {
    "others": {
      "kind": "campaign"
    },
    "rows": [
      {
        "kind": "campaign"
      }
    ]
  },
  "store": {
    "platform": "shopify",
    "status": "connecting",
    "sync": {
      "import": {
        "phase": "products"
      },
      "revokedReason": "",
      "state": "connecting"
    }
  },
  "usedBy": [
    {
      "kind": "automation"
    }
  ],
  "webhooks": [
    {
      "status": "pending"
    }
  ]
}

default

Section titled “default”

Error

Media typeapplication/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"
}
Report a problem with this pageReputeCast websiteHostReputeContent licensed under CC BY 4.0