Download OpenAPI specification:
Graph Service API
| privacyType required | string Enum: "private" "public" Graph type to query (public or private) |
| connectionType required | string Enum: "follow" "friendship" Graph connection type to query (follow or friendship) |
| dsnpIds required | Array of strings non-empty unique Array of MSA Ids for which to query graphs |
Array of objects (GraphKeyPairDto) Graph encryption keypairs for the users requested in |
{- "privacyType": "public",
- "connectionType": "follow",
- "dsnpIds": [
- "2",
- "3",
- "4",
- "5"
], - "graphKeyPairs": [
- {
- "keyType": "X25519",
- "publicKey": "0xd43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d",
- "privateKey": "0xd43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d"
}
]
}[- {
- "dsnpId": "2",
- "dsnpGraphEdges": [
- {
- "userId": "3",
- "since": 12
}
], - "errorMessage": "string"
}
]| 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 <uri> Optional URL of a webhook to invoke when the request is complete |
{- "dsnpId": "2",
- "connections": {
- "data": [
- {
- "privacyType": "public",
- "direction": "connectionTo",
- "connectionType": "follow",
- "dsnpId": "3"
}
]
}, - "graphKeyPairs": [
- {
- "keyType": "X25519",
- "publicKey": "0xd43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d",
- "privateKey": "0xd43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d"
}
],
}{- "referenceId": "bee2d0d2f658126c563088217e106f2fa9e56ed4"
}| dsnpIds | Array of strings unique MSA Ids for which to watch for graph updates |
| webhookEndpoint required | string <uri> Webhook URL to call when graph changes for the referenced MSAs are detected |
{- "dsnpIds": [
- "2",
- "3",
- "4",
- "5"
],
}| msaId required | string Example: 2 Msa Id of requested account |
| includeAll | boolean Example: includeAll=true Boolean whether to include webhooks registered for 'all' MSA Ids (default: true) |
[- "string"
]