Semrush AIO Report Elements

semrushAioReportElements

List the Semrush Enterprise workspaces an account can see, and the AI report pages and elements of one workspace, using a verified account-bound browser profile.

Category: other•Timeout: 120s• Retryable

Input schema

POST this shape to /api/v1/tasks as the input field when creating a task in a group of type semrushAioReportElements.

{
  "type": "object",
  "description": "Keys not declared here are accepted by the server, ignored by the executor and listed in the output's ignoredInputKeys. null for an optional input means not provided. pattern and maxItems below are the executor's limits: the server does not check them. Without workspaceId the task returns only the workspace list.",
  "properties": {
    "accountRef": {
      "type": "string",
      "description": "Operator-chosen account slug; 1-64 letters, digits, dots, underscores or hyphens. Never a credential.",
      "minLength": 1,
      "maxLength": 64,
      "pattern": "^[A-Za-z0-9._-]{1,64}$"
    },
    "workspaceId": {
      "type": "string",
      "description": "Semrush Enterprise workspace whose AI report pages to list. Omit to list only the workspaces this account can see.",
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,127}$"
    },
    "pageId": {
      "type": "string",
      "description": "One report page whose elements to list. Used only with workspaceId.",
      "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,127}$"
    },
    "pageIds": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[A-Za-z0-9][A-Za-z0-9_-]{0,127}$"
      },
      "maxItems": 10,
      "description": "Report pages whose elements to list, at most 10, de-duplicated by the executor. Used only with workspaceId. Without pageId or pageIds, elements are listed for as many pages as fit the task deadline and caps."
    },
    "clientRef": {
      "type": "string",
      "description": "Caller's own reference, echoed as clientRef in the output when it matches ^[A-Za-z0-9._:-]{1,120}$ and omitted otherwise; never fails the task.",
      "pattern": "^[A-Za-z0-9._:-]{1,120}$"
    }
  },
  "required": [
    "accountRef"
  ]
}

Output schema

Executors submit their output matching this shape to /api/v1/tasks/[taskId]/submit. Readers pull it back from task detail endpoints.

{
  "type": "object",
  "properties": {
    "contractVersion": {
      "type": "string",
      "const": "1.0.0"
    },
    "executorVersion": {
      "type": "string",
      "description": "Version of the desktop build that ran the task."
    },
    "clientRef": {
      "type": "string",
      "description": "The input clientRef, when it was valid."
    },
    "fetchedAt": {
      "type": "string",
      "format": "date-time"
    },
    "workspaceId": {
      "type": [
        "string",
        "null"
      ],
      "description": "The input workspaceId; null when the task listed workspaces only."
    },
    "workspaces": {
      "type": "array",
      "maxItems": 50,
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "title": {
            "type": "string",
            "maxLength": 200
          }
        },
        "required": [
          "id",
          "title"
        ]
      },
      "description": "Workspaces this account can see, at most 50. Only id and title: nothing about the signed-in user."
    },
    "workspacesTruncated": {
      "type": "boolean",
      "description": "True when workspaces were left out to fit the caps."
    },
    "projects": {
      "type": "array",
      "maxItems": 50,
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "title": {
            "type": "string",
            "maxLength": 200
          }
        },
        "required": [
          "id",
          "title"
        ]
      },
      "description": "With workspaceId, when the executor could read them: the workspace's AI projects, at most 50."
    },
    "pages": {
      "type": "array",
      "maxItems": 60,
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "title": {
            "type": "string",
            "maxLength": 200
          },
          "path": {
            "type": "string"
          },
          "elements": {
            "type": "array",
            "maxItems": 80,
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "type": {
                  "type": "string"
                },
                "title": {
                  "type": "string",
                  "maxLength": 200
                },
                "product": {
                  "type": "string",
                  "const": "ai"
                },
                "columns": {
                  "type": "array",
                  "maxItems": 120,
                  "items": {
                    "type": "string"
                  }
                },
                "flags": {
                  "type": "object",
                  "properties": {
                    "rank": {
                      "type": "boolean"
                    },
                    "engine": {
                      "type": "boolean"
                    },
                    "date": {
                      "type": "boolean"
                    }
                  },
                  "required": [
                    "rank",
                    "engine",
                    "date"
                  ]
                },
                "filterKeys": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              },
              "required": [
                "id",
                "type",
                "title",
                "product"
              ]
            }
          }
        },
        "required": [
          "id",
          "title",
          "elements"
        ]
      },
      "description": "With workspaceId: the AI product's report pages, at most 60, each with at most 80 elements. Empty without workspaceId."
    },
    "pagesTruncated": {
      "type": "boolean",
      "description": "True when pages were left out: the task deadline or a cap stopped the listing early."
    },
    "elementsTruncated": {
      "type": "boolean",
      "description": "True when elements were left out to fit the caps."
    },
    "ignoredInputKeys": {
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$"
      },
      "description": "Input keys this executor did not recognise and ignored."
    }
  },
  "required": [
    "contractVersion",
    "fetchedAt",
    "workspaceId",
    "workspaces",
    "pages",
    "pagesTruncated"
  ]
}

Ready to run Semrush AIO Report Elements?

Create a project, approve an executor, and push your first semrushAioReportElements task.

Get started