---
updatedAt: 2026-01-05T21:07:56.000Z
agentTools:
  projectIndex: https://developers.koddi.com/llms.txt
---

# Entities Report

## Response

<HTMLBlock>{`
<style type="text/css">.tg {border-collapse:collapse;border-spacing:0;} .tg td{border-color:black;border-style:solid;border-width:1px;font-family:Arial, sans-serif;font-size:14px; overflow:hidden;padding:10px 5px;word-break:normal;} .tg th{border-color:black;border-style:solid;border-width:1px;font-family:Arial, sans-serif;font-size:14px; font-weight:normal;overflow:hidden;padding:10px 5px;word-break:normal;} .tg .tg-viy4{background-color:#FFF;color:#172B4D;text-align:left;vertical-align:top} .tg .tg-ia17{background-color:#F4F5F7;color:#172B4D;font-weight:bold;text-align:left;vertical-align:top} .tg .tg-1dk4{background-color:#F4F5F7;color:#172B4D;text-align:left;vertical-align:top}</style><table id=table1 >
</colgroup><th><tr>
<th>Field<br>
</th><th>Type<br>
</th><th>Description<br>
</th>
</tr>
</thead><tbody><tr>
<td>result</td><td>object</td><td>The total count of all records in the result object across all pages</td>
</tr>
<tr>
<td>entities</td><td>array of objects</td><td>The list of entities and their attributes. The attributes per entity will vary depending on your member group. Please consult your Koddi representative to get your expected attributes.</td>
</tr>
</tbody></table>
`}</HTMLBlock>

## Try it!

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "k1-campaign-management",
    "version": "1"
  },
  "servers": [
    {
      "url": "https://koddi.io/console/v1/"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "Authorization",
        "x-default": "",
        "x-bearer-format": "bearer"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/member_groups/{memberGroupId}/entities_report": {
      "post": {
        "summary": "Entities Report",
        "description": "",
        "operationId": "report-copy",
        "parameters": [
          {
            "name": "memberGroupId",
            "in": "path",
            "description": "The member group ID for the client.",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "pagination": {
                    "properties": {
                      "start": {
                        "type": "integer",
                        "description": "Optional (will be 0 by default). The start index.",
                        "default": 0,
                        "format": "int32"
                      },
                      "count": {
                        "type": "integer",
                        "description": "Optional (will be 20 by default). The count.",
                        "default": 20,
                        "format": "int32"
                      }
                    },
                    "required": [],
                    "type": "object",
                    "description": "Optional (will be ALL elements by default). The pagination parameters."
                  },
                  "sort": {
                    "type": "array",
                    "description": "Optional (will be last_modified ASC by default). The list of sort options.",
                    "items": {
                      "properties": {
                        "field": {
                          "type": "string",
                          "description": "The field to sort on"
                        },
                        "order": {
                          "type": "string",
                          "description": "The order to sort by. Possible options are asc or desc"
                        }
                      },
                      "type": "object"
                    }
                  },
                  "filters": {
                    "type": "array",
                    "description": "The list of filter options",
                    "items": {
                      "properties": {
                        "field": {
                          "type": "string",
                          "description": "The name of the dimension or metric you want to filter on"
                        },
                        "operation": {
                          "type": "string",
                          "description": "The operation to perform. Valid operations are: =, <=, >=, <, >, !=, ILIKE, IN, NOT IN, IS NULL, NOT NULL, NOT ILIKE, BETWEEN. If an operator containing LIKE is used, you must include % as wild cards."
                        },
                        "value": {
                          "type": "string",
                          "description": "The value of the dimension or metric that you want to filter on."
                        },
                        "or group": {
                          "type": "string",
                          "description": "If an or group is provided, any filter within the same or group will be or’d together as opposed to the default operation of and."
                        }
                      },
                      "type": "object"
                    }
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n\"status\": \"success\",\n\"result\": {\n\"unpaginated_count\": 1,\n\"entities\": [\n{\n\"brand\": \"Your Brand\",\n\"taxonomy\": \"Pantry > Condiments > Ketchup\",\n\"taxonomy_id\": \"01008\",\n\"id\": \"12345\",\n\"koddi_entity_id\": 67890,\n\"koddi_entity_group_id\": 1,\n\"koddi_entity_group_name\": \"Product\",\n\"member_group_id\": 1,\n\"name\": \"My Product\",\n\"product_name\": \"My Product\"\n}\n]\n}"
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```