Search API (1.0.0)

Download OpenAPI specification:

Dashboard statistics and search.

dashboard

Get dashboard sync activity

Get recent sync history and next scheduled sync

Authorizations:

BearerAuth

Responses

Response samples

200
500

Content type

application/json

{"data": {"errors": ["string"
],
"nextScheduledSync": "string",
"syncHistory": [{"channelName": "string",
"failedCount": 0,
"id": "string",
"status": "string",
"timeAgo": "string"
}
]
},
"success": true
}

Get current user's tasks

Get tasks assigned to the authenticated user

Authorizations:

BearerAuth

Responses

Response samples

200
500

Content type

application/json

{"data": {"errors": ["string"
],
"myTasks": [{"category": "string",
"dueDate": "string",
"id": "string",
"priority": "string",
"title": "string"
}
]
},
"success": true
}

Get dashboard statistics

Get aggregated statistics for all entities

Authorizations:

BearerAuth

Responses

Response samples

200
500

Content type

application/json

{"data": {"errors": ["string"
],
"stats": {"attributes": {"total": 0
},
"catalogCompleteness": 0,
"catalogCompletenessChange": 0,
"categories": {"total": 0
},
"channelReadiness": [{"channelId": "string",
"channelName": "string",
"percentage": 0
}
],
"channels": {"total": 0
},
"digitalAssets": {"breakdown": [{"color": "string",
"count": 0,
"label": "string",
"storageBytes": 0,
"type": "string"
}
],
"totalStorageBytes": 0,
"usedStorageBytes": 0
},
"jobs": {"import": 0,
"total": 0
},
"productFamily": {"total": 0
},
"productHealth": {"product": {"activePercentage": 0,
"completenessDistribution": [{"color": "string",
"count": 0,
"label": "string",
"max": 0,
"min": 0
}
],
"donutSegments": [{"color": "string",
"percentage": 0
}
],
"topMissingAttributes": [{"color": "string",
"count": 0,
"label": "string"
}
]
},
"variant": {"activePercentage": 0,
"completenessDistribution": [{"color": "string",
"count": 0,
"label": "string",
"max": 0,
"min": 0
}
],
"donutSegments": [{"color": "string",
"percentage": 0
}
],
"topMissingAttributes": [{"color": "string",
"count": 0,
"label": "string"
}
]
}
},
"products": {"approved": 0,
"archived": 0,
"draft": 0,
"inReview": 0,
"thisMonth": 0,
"total": 0
},
"syncSuccessRate": 0,
"syncSuccessRateChange": 0,
"tasks": {"overdue": 0,
"total": 0
},
"translationCoverage": [{"flagCode": "string",
"label": "string",
"locale": "string",
"percentage": 0
}
],
"variants": {"approved": 0,
"archived": 0,
"draft": 0,
"inReview": 0,
"total": 0
}
}
},
"success": true
}