Документация · v1

Creodock API

Все операции
GETИнтерфейс Creodock

Получить: рабочая область

Возвращает рабочая область. Запрос предназначен для чтения и не изменяет данные.

OpenAPI: Read production overview for a manager, owner or admin

GEThttps://api.creodock.com/api/v1/organizations/{organizationId}/overview
Кто вызывает
Интерфейс Creodock
Операция выполняется от имени вошедшего пользователя через защищённую cookie-сессию.
Доступ
Определяется ролью и принадлежностью объекта
Отдельный scope не объявлен в OpenAPI. Сервер проверяет роль и рабочую область.

Что произойдёт

Поведение, которое важно учесть до отправки запроса.

  • Не изменяет данные и подходит для безопасного повторного чтения.
  • Повторный запрос возвращает актуальное состояние ресурса.

Параметры

Где передать значение, обязательно ли оно и откуда его получить.

ПолеГдеТипОписание
organizationIdОбязательно
pathstring · uuid
ID рабочей области. Возьмите его из URL рабочей области или ответа списка рабочих областей.
directionIdНеобязательно
querystring · uuid
Параметр фильтрации или управления выдачей: directionId.

Ответы

Все состояния ответа, объявленные этой операцией в OpenAPI.

200

Server-aggregated creative operational metrics with deprecated legacy fields

application/json

Схема: OverviewResponse

ПолеТипОписание
attentionОбязательно
OverviewAttentionMetric
Поле «attention» в структуре запроса или ответа.
completedTodayОбязательно
OverviewMetric
Поле «completedToday» в структуре запроса или ответа.
dueTodayОбязательно
OverviewMetric
Поле «dueToday» в структуре запроса или ответа.
inWorkОбязательно
OverviewMetric
Поле «inWork» в структуре запроса или ответа.
mixОбязательно
OverviewWorkTypeMix[]
Поле «mix» в структуре запроса или ответа.
operationalОбязательно
OperationalOverview
Поле «operational» в структуре запроса или ответа.
pipelineОбязательно
OverviewPipelineStage[]
Поле «pipeline» в структуре запроса или ответа.
productionОбязательно
object
Поле «production» в структуре запроса или ответа.
teamОбязательно
OverviewTeamMember[]
Поле «team» в структуре запроса или ответа.
timezoneОбязательно
string
Поле «timezone» в структуре запроса или ответа.
todayОбязательно
OverviewTodayTask[]
Поле «today» в структуре запроса или ответа.
{
  "attention": {
    "secondaryLabel": "string",
    "secondaryValue": 1,
    "value": 1
  },
  "completedToday": {
    "secondaryLabel": "string",
    "secondaryValue": 1,
    "value": 1
  },
  "dueToday": {
    "secondaryLabel": "string",
    "secondaryValue": 1,
    "value": 1
  },
  "inWork": {
    "secondaryLabel": "string",
    "secondaryValue": 1,
    "value": 1
  },
  "mix": [
    {
      "completed": 1,
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string"
    }
  ],
  "operational": {
    "asOf": "2026-09-05T12:00:00Z",
    "attentionQueue": [
      {
        "availableAction": "assign",
        "client": {},
        "creativeId": "00000000-0000-0000-0000-000000000000",
        "creativeTitle": "string",
        "deadlineAt": "2026-09-05T12:00:00Z",
        "order": {},
        "priority": "low",
        "reason": "overdue",
        "targetHref": "string"
      }
    ],
    "completedToday": 1,
    "counters": {
      "awaitingReview": 1,
      "dueToday": 1,
      "overdue": 1,
      "unassigned": 1
    },
    "timeline": [
      {
        "availableCapacity": 1,
        "date": "2026-09-05",
        "dueCreatives": 1,
        "workloadPercent": 1
      }
    ],
    "timezone": "string",
    "upcomingDeadlines": [
      {
        "creatives": 1,
        "date": "2026-09-05",
        "overloadedAssignees": 1,
        "unassigned": 1
      }
    ],
    "workload": [
      {
        "activeCreatives": 1,
        "availability": "working",
        "dueToday": 1,
        "membershipId": "00000000-0000-0000-0000-000000000000",
        "name": "string",
        "overdue": 1,
        "review": 1,
        "teamMemberId": "00000000-0000-0000-0000-000000000000",
        "version": 1
      }
    ]
  },
  "pipeline": [
    {
      "stage": "awaiting_payment",
      "total": 1
    }
  ],
  "production": {
    "backlogDelta": 1,
    "completedToday": 1,
    "days30": [
      {
        "completed": 1,
        "date": "2026-09-05"
      }
    ],
    "days7": [
      {
        "completed": 1,
        "date": "2026-09-05"
      }
    ],
    "incomingToday": 1
  },
  "team": [
    {
      "activePositions": 1,
      "dueToday": 1,
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "overdue": 1
    }
  ],
  "timezone": "string",
  "today": [
    {
      "assignees": [
        {}
      ],
      "client": {
        "id": "00000000-0000-0000-0000-000000000000",
        "name": "string"
      },
      "deadlineAt": "2026-09-05T12:00:00Z",
      "id": "00000000-0000-0000-0000-000000000000",
      "number": 1,
      "priority": "low",
      "remainingPositions": 1,
      "title": "string"
    }
  ]
}
401

Problem Details response

application/json

Схема: Problem

403

Problem Details response

application/json

Схема: Problem

Ошибки и восстановление

Не только причина, но и конкретное действие для вызывающей стороны.

СтатусЧто означаетПовторЧто делать
401Нет действующей авторизацииПосле авторизацииПроверьте ключ или пользовательскую сессию.
403Недостаточно правНетИспользуйте ключ или роль с требуемым доступом.

Формат Problem Details

{
  "type": "https://api.creodock.com/problems/invalid-request",
  "title": "Данные не прошли проверку",
  "status": 422,
  "code": "invalid_request",
  "detail": "Проверьте отмеченные поля.",
  "traceId": "req_01J8M4Y6QX",
  "fieldErrors": [
    { "field": "items[0].formats", "code": "required", "message": "Выберите формат." }
  ]
}