The GraphQL API
#Limitations
GraphQL API offers great flexibility by allowing clients to request precisely the data they need.
However, certain limitations are in place to ensure optimal performance.
By setting boundaries, we avoid complex or large queries that could potentially slow down the system.
This is a balancing act between flexibility and performance.
#Rate limiting
Understanding that the limitations are not static and will adapt over time based on usage and requirements is vital.
With the GraphQL API being a recent addition to Akeneo, our priority is to ensure the stability of the PIM by carefully assessing all risks.
If you encounter any challenges with the rate limits, please don't hesitate to reach out by opening a support ticket.
Your insights are invaluable in fine-tuning our system for optimal performance.
The GraphQL API is limited to 100req/10s per PIM URL.
#Query complexity limitations
Each query will have a cost complexity depending on the requested data. A detailed explanation can be found on Complexity calculation.
{
products(limit: 100) {
items {
uuid
categories {
code
}
simpleAssociations {
type
products {
uuid
parent {
code
}
}
}
}
}
}
{
"errors": [
{
"message": "Cost Error: Query Cost limit of 5000 exceeded, found 6200. Reduce the limit argument or the requested fields"
}
]
}
#Depth limitations
A query depth is how much level of data you have. For example, you can make the following query
{
products {
items {
uuid
categories {
code
}
simpleAssociations {
type
products {
uuid
parent {
code
categories {
code
}
}
}
}
}
}
}
{
"errors": [
{
"message": "Depth Error: Query depth limit of 6 for query: [products] exceeded, found 7."
}
]
}
Maximum query depth is set as follows for each GraphQL Query.
| Query | Max Depth |
|---|---|
| assetFamilies | 5 |
| assetsRecords | 3 |
| attributes | 4 |
| attributeOptions | 3 |
| categories | 4 |
| channels | 4 |
| currencies | 3 |
| families | 5 |
| locales | 3 |
| measurementFamilies | 4 |
| productModels | 7 |
| products | 8 |
| referenceEntities | 5 |
| referenceEntitiesRecords | 3 |
| systemInformation | 3 |
Remember that every time you open a bracket, the level of depth increases. This is an important tip to keep in mind.
Understanding that the limitations are not static and will adapt over time based on usage and requirements is vital.
With the GraphQL API being a recent addition to Akeneo, our priority is to ensure the stability of the PIM by carefully assessing all risks.
If you encounter any challenges with the depth limit, please don't hesitate to reach out by opening a support ticket.
Your insights are invaluable in fine-tuning our system for optimal performance.
#One-query limitation
By default, GraphQL allows the execution of several queries by one call.
This is disabled and only one query will be allowed at once.
You will get an error as follows when executing multiple queries in one call.
{
# This is the first query
products {
items {
uuid
}
}
# This is the second query
categories {
items {
code
}
}
}
{
"errors": [
{
"message": "Operation Error: Only one selection is allowed at once, found 2"
}
]
}
#About Assets
GraphQL supports the following:
- Asset Media Links
- Asset Shared Links (available for main media only)
Please note that GraphQL does not support asset media files (binaries), and there are no plans to add this feature in the near future. To create your integration based on the GraphQL outbound API, you will need to have a DAM link or an asset shared link functionality activated. Keep this in mind when using the GraphQL outbound API.