Graph Service (1.0)

Download OpenAPI specification:Download

Graph Service API

v1/graphs

Fetch graphs for specified MSA Ids and Block Number

Request Body schema: application/json
required
privacyType
required
string (PrivacyType)
Enum: "private" "public"

Indicator connection type (public or private)

connectionType
required
string (ConnectionType)
Enum: "follow" "friendship"

Indicator of the type of connection (follow or friendship)

dsnpIds
required
Array of strings

Array of MSA Ids for which to query graphs

Array of objects (GraphKeyPairDto)

Graph encryption keypairs for the users requested in dsnpIds. (Only for privacyType === "private"

Responses

Request samples

Content type
application/json
{
  • "privacyType": "private",
  • "connectionType": "follow",
  • "dsnpIds": [
    ],
  • "graphKeyPairs": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Request an update to a given user's graph

Request Body schema: application/json
required
dsnpId
required
string

MSA Id that owns the connections represented in this object

required
object

Array of connections known to the Provider for ths MSA referenced in this object

Array of objects (GraphKeyPairDto)

Optional array of graph encryption keypairs decrypting/encrypting the above-referenced users private graph

webhookUrl
string

Optional URL of a webhook to invoke when the request is complete

Responses

Request samples

Content type
application/json
{
  • "dsnpId": "2",
  • "connections": {
    },
  • "graphKeyPairs": [
    ],
  • "webhookUrl": "http://localhost/webhook"
}

Response samples

Content type
application/json
{
  • "referenceId": "bee2d0d2f658126c563088217e106f2fa9e56ed4"
}

health

Check the health status of the service

Responses

Check the live status of the service

Responses

Check the ready status of the service

Responses

v1/webhooks

Get all registered webhooks

Responses

Watch graphs for specified dsnpIds and receive updates

Request Body schema: application/json
required
dsnpIds
Array of strings

MSA Ids for which to watch for graph updates

webhookEndpoint
required
string

Webhook URL to call when graph changes for the referenced MSAs are detected

Responses

Request samples

Content type
application/json
{}

Delete all registered webhooks

Responses

Get all registered webhooks for a specific MSA Id

path Parameters
msaId
required
string
Example: 2

Msa Id of requested account

query Parameters
includeAll
boolean
Example: includeAll=true

Boolean whether to include webhooks registered for 'all' MSA Ids (default: true)

Responses

Response samples

Content type
application/json
[
  • "string"
]

Delete all webhooks registered for a specific MSA

path Parameters
msaId
required
string
Example: 2

Msa Id of requested account

Responses

Get all webhooks registered to the specified URL

query Parameters
url
required
string
Example: url=http://localhost/webhook

URL related to the request

Responses

Response samples

Content type
application/json
[
  • "string"
]

Delete all MSA webhooks registered with the given URL

query Parameters
url
required
string
Example: url=http://localhost/webhook

URL related to the request

Responses